Loading ...

REST API: Get Case Comments | Communifire Documentation

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

REST API: Get Case Comments

0 
 /5
0 (0votes)

Get Case Comments

GET /api/case/comments

Get a list of comments made on a specific 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.
CaseID &CaseID=x - Used in the request URL as a query parameter ID value which uniquely identifies each issue in the Communifire.

Example Request

GET https://myintranet.communifire.com/api/case/comments?CaseID=323

Example Response

Case comment JSON is returned as ResponseData.


{
    "IsError":false,
    "ResponseMessage":"",
    "ResponseData":
    [
        {
            "CommentID":79,
            "IsInternal":false,
            "IssueID":323,
            "ProjectID":0,
            "IsProjectActive":false,
            "SpaceID":0,
            "Status":0,
            "UserID":1,
            "UserName":"John",
            "CommentText":"You need to style your list items with the following property: display: inline; Hope this helps.",
            "CommentTextUnprocessed":"You need to style your list items with the following property: display: inline; Hope this helps.",
            "CommentDate":"2016-02-04T07:00:56.21",
            "MediaServerRootURL":"https://myintranet.communifire.com/Assets/Uploaded-Photos",
            "LastUpdatedByUserID":0,
            "LastUpdatedOn":"0001-01-01T00:00:00",
            "IssueStatusID":0,
            "CommentTextHtmlFormatted":"You need to style your list items with the following property: display: inline; Hope this helps.",
            "CommentTextFormatted":"You need to style your list items with the following property: display: inline; Hope this helps."
        },
		{
			"CommentID":80,
			"IsInternal":false,
			"IssueID":323,
			"ProjectID":0,
			"IsProjectActive":false,
			"SpaceID":0,
			"Status":0,
			"UserID":1,
			"UserName":"John",
			"CommentText":"This issue has been resolved. Please check.",
			"CommentTextUnprocessed":"This issue has been resolved. Please check.",
			"CommentDate":"2016-02-04T07:00:34.93",
			"MediaServerRootURL":"https://myintranet.communifire.com/Assets/Uploaded-Photos",
			"LastUpdatedByUserID":0,
			"LastUpdatedOn":"0001-01-01T00:00:00",
			"IssueStatusID":0,
			"CommentTextHtmlFormatted":"This issue has been resolved. Please check.",
			"CommentTextFormatted":"This issue has been resolved. Please check."
		}
	]
}

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

Wiki Index

Pages

Intranet Software