TeamRoom Panel API

Overview

This endpoint exposes several actions needed to configure panels in a Planning Room or TeamRoom. This endpoint helps you to install a panel, remove a panel, retrieve information about installed panels, and available panels.

Get all available panels

Endpoint

/api/teamroom/panels?roomcontext=TeamRoom:1314

Method

GET

Description

This API endpoint retrieves all available panels in a TeamRoom.

Parameters

• room Context - Specifies the team room token.

Response

• HTTP Status Code: 200 (OK)
• Headers:
  • Content-Type: application/json

JSON Response:

[

{

"type": "Backlog",

"name": "Backlog",

"description": "Planning and prioritization of your agile Backlog in a list view.",

"isRemovable": false

},

// other available panels

]

• "type": A string representing the panel type.
• "name": A string representing the name of the panel.
• "description": A string providing a description of the panel.
• "isRemovable": A boolean value indicating whether the panel is removable.

Get all installed panels

Endpoint

/api/teamroom/ installedpanels?roomcontext=TeamRoom:1314

Method

GET

Description

This API endpoint retrieves all the installed panels from theTeamRoom.

Parameters

• room Context - Specifies the team room token.

Response

• HTTP Status Code: 200 (OK)
• Headers:
  • Content-Type: application/json

JSON Response:

{

"type": "Issues",

"name": "Issues",

"description": "Assets that capture roadblocks or dependencies”,

"isRemovable": false

}

• "type": A string representing the panel type.
• "name": A string representing the name of the panel.
• "description": A string providing a description of the panel.
• "isRemovable": A boolean value indicating whether the panel is removable.

Install a panel

Endpoint

/api/teamroom/installpanel?roomcontext=TeamRoom:1314&type=issues

Method

POST

Description

This API endpoint installs a panel in a TeamRoom.

Parameters

• room Context - Specifies the team room token.
• type - The type of panel that needs to be installed. This value can be obtained from the available panels' response.

Response

• HTTP Status Code: 201 (Created)
• Headers:
  • Content-Type: application/json

JSON Response:

[

{

"type": "Backlog",

"name": "Backlog",

"description": "Planning and prioritization of your agile Backlog in a list view.",

"isRemovable": false

},

// other installed panels

]

• "type": A string representing the panel type.
• "name": A string representing the name of the panel.
• "description": A string providing a description of the panel.
• "isRemovable": A boolean value indicating whether the panel is removable.

Remove a panel

Endpoint

/api/teamroom/ removepanel?roomcontext=TeamRoom:1314&type=issues

Method

POST

Description

This API endpoint removes a panel from the TeamRoom.

Parameters

• room Context - Specifies the team room token.
• type - The type of panel that needs to be removed. This value can be obtained from the available panels' response.

Response

• HTTP Status Code: 204 (No Content)