Loading ...

REST API: Create Case | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Cases » REST API: Create Case
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 17

REST API: Create Case

0 
 /5
0 (0votes)

Create Case

POST /api/cases

Create a new case. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
POST
Response Format
JSON
Requires Authentication?
YES
Product Version
5.2 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.
Case JSON Used in the request body This is JSON that represents a case object that you're creating. This should be of the format seen below in the sample given. The required values in this JSON are given below.
IssueTitle Used in the request body Title of the issue.
IssueDescription Used in the request body Brief description about the issue.
Optional Parameters How to use Description
ReportedByUserID Used in the request body Unique user ID of the user who reported the issue.
MilestoneID Used in the request body Unique ID of the milestone after which the issue will be fixed.
AssignedToUserID Used in the request body ID of the user to whom the issue has been assigned.
ProjectID Used in the request body ID of the project under which the issue persists.
ProjectSectionID Used in the request body ID of the project section under which the issue persists.
IssuePriorityID Used in the request body Priority ID; indicating the intensity of the issue.
IssueStatusID Used in the request body Status ID; indicating the current status of the issue.
SpaceID Used in the request body ID of the space under which you want to create the issue.
TagsCSV Used in the request body Comma-separated list of the tags (Available for v6.0+)
RecipientUserIDCSV Used in the request body Recipients user IDs csv (Available for v6.0+)
DateStringTaskEnd Used in the request body Date and time indicating the case due date.

Ensure DateStringTaskEnd is provided in the date/time format and time zone of the API user.

Example Request

POST https://myintranet.communifire.com/api/cases

Body:

{
    "IssueTitle": "iPhone app keeps crashing",
    "IssueDescription":"iPhone app keeps crashing. Tried soft restart, tried clearing account from phone and re-adding. Neither worked.",
    "SpaceID": 1
}

Example Response

Issue ID is returned as ResponseData.

{
    "IsError":false,
    "ResponseMessage":"ToBePublished",
    "ResponseData":297
}

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

 

Wiki Index

Pages

Intranet Software