Loading ...

REST API: Get Case | Communifire Documentation

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

REST API: Get Case

0 
 /5
0 (0votes)

Get Case

GET /api/cases/{IssueID}

Get a case. Valid for Communifire version 5.2 and above.

Method Details

HTTP Method
GET
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.
IssueID Used in the request URL as a path parameter Unique identifier for a particular case.

Example Request

GET https://myintranet.communifire.com/api/cases/319

Example Response

Case JSON object is returned as ResponseData.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":
        {
            "IssueID":319,
            "MilestoneID":0,
            "MilestoneTitle":null,
            "MilestoneUrl":null,
            "IssueTitle":"css not working",
            "CommentCount":0,
            "IssueDescription":"Page layout is breaking.",
            "IssueDescriptionUnprocessed":"Page layout is breaking.",
            "DateCreated":"2016-02-03T11:09:04.087",
            "ReportedByUserID":1,
            "ReportedByUserName":"john",
            "ReportedByUserEmail":"acme@acme.com",
            "ReportedByUserDisplayName":"John Smith",
            "ReportedByUserProfileURL":"http://myintranet.communifire.com/people/john",
            "AssignedToUserID":0,
            "AssignedToUserDislplayName":null,
            "AssignedToUserProfileURL":null,
            "ProjectID":1,
            "ProjectTitle":"Customer Support",
            "ProjectSectionID":1,
            "ProjectSectionName":"Application",
            "IssueStatusID":1,
            "IssueStatusName":"New",
            "IssuePriorityID":0,
            "IssuePriorityName":null,
            "DateUpdated":"2016-02-03T11:09:04.087",
            "DateUpdatedText":"26 minutes ago",
            "LastUpdatedByUserID":0,
            "LastUpdatedByUserName":null,
            "LastUpdatedByUserFirstName":null,
            "LastUpdatedByUserLastName":null,
            "LastUpdatedByUserEmail":null,
            "LastUpdatedByUserDisplayName":null,
            "LastUpdatedByUserProfileURL":null,
            "Tagname":null,
            "UserID":1,
            "UserName":null,
            "DateAssigned":"0001-01-01T00:00:00",
            "SpaceID":0,
            "SpaceName":"",
            "IssueComment":null,
            "IsCommented":false,,
            "IssueURL":"/cases/case/319",
        }
}


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

 

Wiki Index

Pages

Intranet Software