Loading ...

REST API: Get Case Projects | Communifire Documentation

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

REST API: Get Case Projects

0 
 /5
0 (0votes)

Get Case Projects

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

Get case projects 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/252/cases/projects

Example Response

Case project JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "ResponseData": [
    {
      "ProjectID": 484,
      "IsDefaultProject": true,
      "ProjectTitle": "HR Question",
      "ProjectDescription": "HR Question",
      "IsActive": true,
      "UserID": 376,
      "DateCreated": "2017-07-04T08:05:31.37",
      "SpaceID": 252,
      "SpaceName": "Human Resources",
      "UserName": "admin",
      "IsTaskProject": false,
      "CanBeEdited": false,
      "CanBeDeleted": false,
      "CanBeSorted": false,
      "TenantID": 1
    },
    {
      "ProjectID": 512,
      "IsDefaultProject": false,
      "ProjectTitle": "Annual Handbook Revision",
      "ProjectDescription": "Annual Handbook Revision",
      "IsActive": true,
      "UserID": 376,
      "DateCreated": "2018-11-01T22:26:48.617",
      "SpaceID": 252,
      "SpaceName": "Human Resources",
      "UserName": "admin",
      "IsTaskProject": false,
      "CanBeEdited": false,
      "CanBeDeleted": false,
      "CanBeSorted": false,
      "TenantID": 1
    },
    {
      "ProjectID": 513,
      "IsDefaultProject": false,
      "ProjectTitle": "2019 Conference",
      "ProjectDescription": "2019 Conference",
      "IsActive": true,
      "UserID": 376,
      "DateCreated": "2018-11-01T22:28:33.35",
      "SpaceID": 252,
      "SpaceName": "Human Resources",
      "UserName": "admin",
      "IsTaskProject": false,
      "CanBeEdited": false,
      "CanBeDeleted": false,
      "CanBeSorted": false,
      "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