Loading ...

REST API: Get Task Comments | Communifire Documentation

Home » communifire documentation » Wiki » Documentation » REST API » REST API: Content » REST API: Tasks » REST API: Get Task Comments
Communifire Documentation  Wiki
Public Space
Activity Stream Content
Version 1

REST API: Get Task Comments

0 
 /5
0 (0votes)

Get Task Comments

GET /api/tasks/{TaskID}/comments

Get a list of comments on a specific task. Valid for Communifire version 8.0 and above.

Method Details

HTTP Method
GET
Response Format
JSON
Requires Authentication?
YES
Product Version
8.0 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.
TaskID Used in the request URL as a path parameter Unique ID of the task
Optional Parameters How to use Description
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/tasks/489/comments

Example Response

Task comment JSON object is returned as ResponseData.

{
  "IsError": false,
  "ResponseMessage": "",
  "TotalRecords": 2,
  "ResponseData": [
    {
      "CommentID": 258,
      "IsInternal": false,
      "IssueID": 489,
      "ProjectID": 0,
      "SpaceID": 252,
      "Status": 1,
      "UserID": 525,
      "UserName": "maria",
      "UserFirstName": "Maria",
      "UserLastName": "Shears",
      "CommentText": "Hi Ben. That attachment is the latest update. If you feel it needs an update, let me know and we'll get someone to work on it. thanks!",
      "CommentTextUnprocessed": "Hi Ben. That attachment is the latest update. If you feel it needs an update, let me know and we'll get someone to work on it. thanks!",
      "CommentTags": "",
      "IssueTitle": "Discuss role, goals, and projects with supervisor",
      "AvatarPath": "https://myintranet.communifire.com/Assets/Uploaded-Photos/525/859d3bc5-ebff-42cc-83fd-adf1efd42fdb.jpg",
      "UserProfilePath": "https://myintranet.communifire.com/people/maria",
      "CommentDate": "2018-03-12T15:48:54.81",
      "CommentDateFullText": "Monday, March 12, 2018 at 08:48",
      "CommentDateString": "12/03/18",
      "IssueStatusID": 0,
      "OldIssueStatusID": 0,
      "CommentTextHtmlFormatted": "Hi Ben. That attachment is the latest update. If you feel it needs an update, let me know and we'll get someone to work on it. thanks!",
      "CommentTextFormatted": "Hi Ben. That attachment is the latest update. If you feel it needs an update, let me know and we'll get someone to work on it. thanks!",
      "IssueCommentURL": "/spaces/252/human-resources/cases/case/489#258",
      "UserDisplayName": "Maria Shears",
      "CanBeDeleted": true,
      "CanBeEdited": true,
      "IssueReportedByUserID": 0,
      "TenantID": 1
    },
    {
      "CommentID": 257,
      "IsInternal": false,
      "IssueID": 489,
      "ProjectID": 0,
      "SpaceID": 252,
      "Status": 1,
      "UserID": 595,
      "UserName": "ben-n",
      "UserFirstName": "Ben",
      "UserLastName": "Newman",
      "CommentText": "I'll be setting this meeting up this week. Does anyone know if we have an updated RoleGuidelines.pdf? Thanks in advance.",
      "CommentTextUnprocessed": "I'll be setting this meeting up this week. Does anyone know if we have an updated RoleGuidelines.pdf? Thanks in advance.",
      "CommentTags": "",
      "IssueTitle": "Discuss role, goals, and projects with supervisor",
      "AvatarPath": "https://myintranet.communifire.com/Assets/Uploaded-Photos/595/c990f71d-f5f9-4908-b9e1-32b240cda4ec.jpg",
      "UserProfilePath": "https://myintranet.communifire.com/people/ben-n",
      "CommentDate": "2018-03-12T15:47:54.513",
      "CommentDateFullText": "Monday, March 12, 2018 at 08:47",
      "CommentDateString": "12/03/18",
      "IssueStatusID": 0,
      "OldIssueStatusID": 0,
      "CommentTextHtmlFormatted": "I'll be setting this meeting up this week. Does anyone know if we have an updated RoleGuidelines.pdf? Thanks in advance.",
      "CommentTextFormatted": "I'll be setting this meeting up this week. Does anyone know if we have an updated RoleGuidelines.pdf? Thanks in advance.",
      "IssueCommentURL": "/spaces/252/human-resources/cases/case/489#257",
      "UserDisplayName": "Ben Newman",
      "CanBeDeleted": true,
      "CanBeEdited": true,
      "IssueReportedByUserID": 0,
      "TenantID": 1
    }
  ]
}

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

Wiki Index

Pages

Intranet Software