Loading ...

REST API: Update Case | Communifire Documentation

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

REST API: Update Case

0 
 /5
0 (0votes)

Update Case

PUT /api/cases/{CaseID}

Update an existing case. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
PUT
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.
CaseID Used in the request URL as a path parameter Unique identifier for a particular case.
Case JSON Used in the request body This is JSON that represents a case object that you're updating. This should be of the format seen below in the sample given.
Optional Parameters How to use Description
IssueTitle Used in the request body Title of the issue.
IssueDescription Used in the request body Brief description about 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.
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

PUT https://myintranet.communifire.com/api/cases/2304


"{ 
   \"IssueTitle\":\"Unable to load the page.\",
   \"IssueDescription\":\"When I try to load the page, it shows 404. Yesterday it was existing.\"
}"

Note: Stringify your JSON data.

Example Response

Issue ID is returned as ResponseData.

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

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

Wiki Index

Pages

Intranet Software