Loading ...

REST API: Get Case Statuses | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Cases » REST API: Get Case Statuses
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 4

REST API: Get Case Statuses

0 
 /5
0 (0votes)

Get Case Statuses

GET /api/spaces/{SpaceID}/cases/statuses

Get case statuses for a space. Valid for Communifire version 6.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
6.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 Used in the request URL as a path parameter

Unique identifier for a particular space.

Example Request

GET https://myintranet.communifire.com/api/spaces/3/cases/statuses

Example Response

Case status JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "IssueStatusID": 33,
      "StatusType": 2,
      "IssueStatusName": "Closed",
      "SpaceID": 3,
      "StatusColorCssClass": "case-status-label-closed",
      "IssueStatusNameKey": 0,
      "IsDefault": false,
      "TaskStatusType": 0,
      "TenantID": 1
    },
    {
      "IssueStatusID": 36,
      "StatusType": 1,
      "IssueStatusName": "Feedback Required",
      "SpaceID": 3,
      "StatusColorCssClass": "case-status-label-feedbackrequired",
      "IssueStatusNameKey": 0,
      "IsDefault": false,
      "TaskStatusType": 0,
      "TenantID": 1
    },
    {
      "IssueStatusID": 32,
      "StatusType": 2,
      "IssueStatusName": "Fixed",
      "SpaceID": 3,
      "StatusColorCssClass": "case-status-label-fixed",
      "IssueStatusNameKey": 0,
      "IsDefault": false,
      "TaskStatusType": 0,
      "TenantID": 1
    },
    {
      "IssueStatusID": 34,
      "StatusType": 1,
      "IssueStatusName": "In Progress",
      "SpaceID": 3,
      "StatusColorCssClass": "case-status-label-inprogress",
      "IssueStatusNameKey": 0,
      "IsDefault": false,
      "TaskStatusType": 0,
      "TenantID": 1
    },
    {
      "IssueStatusID": 31,
      "StatusType": 1,
      "IssueStatusName": "New",
      "SpaceID": 3,
      "StatusColorCssClass": "case-status-label-new",
      "IssueStatusNameKey": 0,
      "IsDefault": true,
      "TaskStatusType": 0,
      "TenantID": 1
    },
    {
      "IssueStatusID": 35,
      "StatusType": 1,
      "IssueStatusName": "Reopened",
      "SpaceID": 3,
      "StatusColorCssClass": "case-status-label-reopened",
      "IssueStatusNameKey": 0,
      "IsDefault": false,
      "TaskStatusType": 0,
      "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