Loading ...

REST API: Get Cases | Communifire Documentation

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

REST API: Get Cases

0 
 /5
0 (0votes)

Get Cases

GET /api/cases

Get a list of cases. 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.
Optional Parameters How to use Description
SpaceID &SpaceID=x - Used in the request URL as a query parameter ID of the space under which the case is reported.
IssueStatusID &IssueStatusID=x - Used in the request URL as a query parameter Status ID; indicating the current status of the case.
Keyword &Keyword=x - Used in the request URL as a query parameter The search keyword to return content for.
IssueStatusType &IssueStatusType=x - Used in the request URL as a query parameter

The issue status type:
Open = 1
Closed = 2
ReportedByUserID &ReportedByUserID=x - Used in the request URL as a query parameter The ID of the user to return cases for.
AssignedToUserID &AssignedToUserID=x - Used in the request URL as a query parameter The ID of the assigned user to return cases for.
MilestoneID &MilestoneID=x - Used in the request URL as a query parameter The ID of the milestone to return cases for.
ProjectID &ProjectID=x - Used in the request URL as a query parameter The ID of the project to return cases for.
CategoryID &CategoryID=x - Used in the request URL as a query parameter The ID of the category to return cases for.
PriorityID &PriorityID=x - Used in the request URL as a query parameter The ID of the priority to return cases for.
StartPage &StartPage=x - Used in the request URL as a query parameter Specifies the starting page of list to be returned.
PageLength &PageLength=x - Used in the request URL as a query parameter Specifies the number of results to be returned per page.

Example Request

GET https://myintranet.communifire.com/api/cases?SpaceID=0&IssueStatusID=1

Example Response

Case JSON object is returned as ResponseData.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData": [
        {
            "IssueID":321,
            "MilestoneID":0,
            "MilestoneTitle":null,
            "MilestoneUrl":null,
            "TaskSortOrder":0,
            "IssueTitle":"Chat not working",
            "CommentCount":0,
            "IssueDescription":"When I type, it redirects me to another page.",
            "IssueDescriptionUnprocessed":"When I type, it redirects me to another page.",
            "DateCreated":"2016-02-03T13:35:09.373",
            "ReportedByUserID":1,
            "ReportedByUserName":"john",
            "ReportedByUserEmail":"acme@acme.com",
            "ReportedByUserDisplayName":"John Smith",
            "ReportedByUserProfileURL":"http://myintranet.communifire.com/people/john",
            "AssignedToUserID":0,
            "OldAssignedToUserID":0,
            "AssignedToUserDislplayName":null,
            "AssignedToUserProfileURL":null,
            "ProjectID":1,
            "ProjectTitle":"Customer Support",
            "ProjectSectionID":1,
            "ProjectSectionName":"Application",
            "IssueStatusID":1,
            "OldIssueStatusID":1,
            "IssueStatusName":"New",
            "IssuePriorityID":0,
            "IssuePriorityName":null,
            "DateUpdated":"2016-02-03T13:35:09.373",
            "DateUpdatedText":"16 seconds ago",
            "LastUpdatedByUserID":0,
            "LastUpdatedByUserName":null,
            "LastUpdatedByUserFirstName":null,
            "LastUpdatedByUserLastName":null,
            "LastUpdatedByUserEmail":null,
            "LastUpdatedByUserDisplayName":null,
            "LastUpdatedByUserProfileURL":null,
            "Tagname":null,
            "ReferenceIDs":null,
            "RecipientUserIDList":null,
            "RecipientUserIDCSV":null,
            "UserID":0,
            "UserName":null,
            "DateAssigned":"0001-01-01T00:00:00",
            "SpaceID":0,
            "SpaceName":null,
            "IssueComment":null,
            "StatusColorCssClass":"case-status-label-new",
            "IsStarred":false,
            "DateTaskStart":null,
            "DateTaskEnd":null,
            "DateStringTaskStart":null,
            "DateStringTaskEnd":null,
            "IsTaskItem":false,
            "PredecessorIssueID":0,
            "IsCommented":false,
            "IsEscalated":false,
            "CopiedFromIssueID":0,
            "CanCopyCase":false,
            "IssueURL":"/cases/case/321",
            "IssueCommentsURL":"/cases/case/321#comments"
        },
        {
            "IssueID":320,
            "MilestoneID":0,
            "MilestoneTitle":null,
            "MilestoneUrl":null,
            "TaskSortOrder":0,
            "IssueTitle":"Aliquid distinctio omnis voluptatem.",
            "CommentCount":0,
            "IssueDescription":"Temporibus eveniet dolores ut.",
            "IssueDescriptionUnprocessed":"Temporibus eveniet dolores ut.",
            "DateCreated":"2016-02-03T13:03:26.847",
            "ReportedByUserID":1,
            "ReportedByUserName":"john",
            "ReportedByUserEmail":"acme@acme.com",
            "ReportedByUserDisplayName":"John Smith",
            "ReportedByUserProfileURL":"http://myintranet.communifire.com/people/john",
            "AssignedToUserID":0,
            "OldAssignedToUserID":0,
            "AssignedToUserDislplayName":null,
            "AssignedToUserProfileURL":null,
            "ProjectID":1,
            "ProjectTitle":"Customer Support",
            "ProjectSectionID":1,
            "ProjectSectionName":"Application",
            "IssueStatusID":1,
            "OldIssueStatusID":1,
            "IssueStatusName":"New",
            "IssuePriorityID":0,
            "IssuePriorityName":null,
            "DateUpdated":"2016-02-03T13:03:26.847",
            "DateUpdatedText":"31 minutes ago",
            "LastUpdatedByUserID":0,
            "LastUpdatedByUserName":null,
            "LastUpdatedByUserFirstName":null,
            "LastUpdatedByUserLastName":null,
            "LastUpdatedByUserEmail":null,
            "LastUpdatedByUserDisplayName":null,
            "LastUpdatedByUserProfileURL":null,
            "Tagname":null,
            "ReferenceIDs":null,
            "RecipientUserIDList":null,
            "RecipientUserIDCSV":null,
            "UserID":0,
            "UserName":null,
            "DateAssigned":"0001-01-01T00:00:00",
            "SpaceID":0,
            "SpaceName":null,
            "IssueComment":null,
            "StatusColorCssClass":"case-status-label-new",
            "IsStarred":false,
            "DateTaskStart":null,
            "DateTaskEnd":null,
            "DateStringTaskStart":null,
            "DateStringTaskEnd":null,
            "IsTaskItem":false,
            "PredecessorIssueID":0,
            "IsCommented":false,
            "IsEscalated":false,
            "CopiedFromIssueID":0,
            "CanCopyCase":false,
            "IssueURL":"/cases/case/320",
            "IssueCommentsURL":"/cases/case/320#comments"
        },
        {
            "IssueID":319,
            "MilestoneID":0,
            "MilestoneTitle":null,
            "MilestoneUrl":null,
            "TaskSortOrder":0,
            "IssueTitle":"Reiciendis ea culpa quisquam occaecati voluptatum ut.",
            "CommentCount":0,
            "IssueDescription":"Quis quia natus dolorem corporis quo sequi autem aliquam.",
            "IssueDescriptionUnprocessed":"Quis quia natus dolorem corporis quo sequi autem aliquam.",
            "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,
            "OldAssignedToUserID":0,
            "AssignedToUserDislplayName":null,
            "AssignedToUserProfileURL":null,
            "ProjectID":1,
            "ProjectTitle":"Customer Support",
            "ProjectSectionID":1,
            "ProjectSectionName":"Application",
            "IssueStatusID":1,
            "OldIssueStatusID":1,
            "IssueStatusName":"New",
            "IssuePriorityID":0,
            "IssuePriorityName":null,
            "DateUpdated":"2016-02-03T11:09:04.087",
            "DateUpdatedText":"2 hours ago",
            "LastUpdatedByUserID":0,
            "LastUpdatedByUserName":null,
            "LastUpdatedByUserFirstName":null,
            "LastUpdatedByUserLastName":null,
            "LastUpdatedByUserEmail":null,
            "LastUpdatedByUserDisplayName":null,
            "LastUpdatedByUserProfileURL":null,
            "Tagname":null,
            "ReferenceIDs":null,
            "RecipientUserIDList":null,
            "RecipientUserIDCSV":null,
            "UserID":0,
            "UserName":null,
            "DateAssigned":"0001-01-01T00:00:00",
            "SpaceID":0,
            "SpaceName":null,
            "IssueComment":null,
            "StatusColorCssClass":"case-status-label-new",
            "IsStarred":false,
            "DateTaskStart":null,
            "DateTaskEnd":null,
            "DateStringTaskStart":null,
            "DateStringTaskEnd":null,
            "IsTaskItem":false,
            "PredecessorIssueID":0,
            "IsCommented":false,
            "IsEscalated":false,
            "CopiedFromIssueID":0,
            "CanCopyCase":false,
            "IssueURL":"/cases/case/319",
            "IssueCommentsURL":"/cases/case/319#comments"
        }
    ]
}

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

 

Wiki Index

Pages

Intranet Software