Loading ...

REST API: Get Space Task Statuses | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Tasks » REST API: Get Space Task Statuses
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 2

REST API: Get Space Task Statuses

0 
 /5
0 (0votes)

Get Space Task Statuses

GET /api/tasks/statuses

Get task statuses for a certain space. Valid for Communifire version 8.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
8.0 and above
Required Parameters How to use Description
API Key Used in the request URL:
&token=x
OR
Set in header:
request.Headers.Add(Rest-Api-Key, x)

Communifire REST API key for the Communifire portal you are making the call for.
SpaceID &SpaceID=x - Used in the request URL as a query parameter

ID of the space to get task statuses for.

Example Request

GET https://myintranet.communifire.com/api/tasks/statuses?SpaceID=285

Example Response

Task statuses JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "IssueStatusID": 2389,
      "StatusType": 0,
      "IssueStatusName": "Active",
      "SpaceID": 285,
      "StatusColorCssClass": "task-status-active",
      "IssueStatusNameKey": 0,
      "IsDefault": true,
      "TaskStatusType": 1,
      "StatusIconCssClass": "icon-circle-blank",
      "TenantID": 1
    },
    {
      "IssueStatusID": 2390,
      "StatusType": 0,
      "IssueStatusName": "Completed",
      "SpaceID": 285,
      "StatusColorCssClass": "task-status-completed",
      "IssueStatusNameKey": 0,
      "IsDefault": false,
      "TaskStatusType": 2,
      "StatusIconCssClass": "icon-ok-sign",
      "TenantID": 1
    },
    {
      "IssueStatusID": 2391,
      "StatusType": 0,
      "IssueStatusName": "In Progress",
      "SpaceID": 285,
      "StatusColorCssClass": "task-status-inprogress",
      "IssueStatusNameKey": 0,
      "IsDefault": false,
      "TaskStatusType": 1,
      "StatusIconCssClass": "icon-play",
      "TenantID": 1
    },
    {
      "IssueStatusID": 2392,
      "StatusType": 0,
      "IssueStatusName": "On Hold",
      "SpaceID": 285,
      "StatusColorCssClass": "task-status-onhold",
      "IssueStatusNameKey": 0,
      "IsDefault": false,
      "TaskStatusType": 1,
      "StatusIconCssClass": "icon-pause",
      "TenantID": 1
    }
  ]
}

 

Please Note The content type that you pass in the header of your request should be application/json.

 

Wiki Index

Pages

Intranet Software