Status List
Retrieve the list of all statuses in the specified channel within a team.
GET odata/status
--x-appvity-channelId: [ChannelID]
--x-appvity-teamid: [TeamID]
--Cookie: graphNodeCookie=[ID]
URL Endpoint
odata/status
Method
GET.
Parameters
This method supports the $filter and $select OData Filter to help customize the response.
Request
Header
--x-appvity-channelId: [ChannelID]
--x-appvity-teamid: [TeamID]
--Cookie: graphNodeCookie=[ID]
Body
This method does not supply the request body.
Response
If successful, this method returns a 200 OK response code and the list of statuses object in the response body.
{
"@odata.context":
"https://schema.appvity.com/odata/$metadata#status(_id,name,primary,color)",
"value": [
{
"_id": [StatusID],
"type": [entityType],
"name": "[Statusname],
"category": [Category],
"description": [StatusDescription],
"order":[OrderNo],
"value": [OrderNo],
"color": [ColorCode],
"primary": [true/false]
}
]
}
Example:
{
"@odata.context": "https://schema.appvity.com/odata/$metadata#status",
"value": [
{
"_id": "5f5ed9639669798c318eb767",
"type": "Task",
"name": "Not Started",
"category": "New",
"description": "A new thing to do",
"order": 1,
"value": 1,
"color": "#C3C8C0",
"primary": ## true##
},
{
"_id": "5f5ed9639669798c318eb768",
"type": "Task",
"name": "In Progress",
"category": "Active",
"description": "Happening",
"order": 2,
"value": 2,
"color": "#78BD6A",
"primary": ## false##
},
{
"_id": "5f5ed9639669798c318eb76a",
"type": "Task",
"name": "Completed",
"category": "Done",
"description": "Finish doing something",
"order": 4,
"value": 4,
"color": "#474876",
"primary": ## false##
},
{
"_id": "5f5ed9639669798c318eb76b",
"type": "Bug",
"name": "Not Started",
"category": "New",
"description": "A new thing to do",
"order": 1,
"value": 1,
"color": "#C3C8C0",
"primary": ## true##
},
{
"_id": "5f5ed9639669798c318eb76c",
"type": "Bug",
"name": "In Progress",
"category": "Active",
"description": "Happening",
"order": 2,
"value": 2,
"color": "#78BD6A",
"primary": ## false##
},
{
"_id": "5f5ed9639669798c318eb76d",
"type": "Bug",
"name": "Resolved",
"category": "Active",
"description": "End a problem",
"order": 3,
"value": 3,
"color": "#295499",
"primary": ## false##
},
{
"_id": "5f5ed9639669798c318eb76f",
"type": "Bug",
"name": "Completed",
"category": "Done",
"description": "Stop operating",
"order": 5,
"value": 5,
"color": "#6162A5",
"primary": ## false##
}
]
}
Error
Code: 401 UNAUTHORIZED, 500 ERROR EXCEPTION.
Content: {error: "error message”}
