GET Task Comments

Edit online

This REST request returns either a specific comment or all the comments in a task instance, including associated attachments. The underlying built-in service is pub.task.taskclient:getTaskComments.

To return a specific comment, the HTTP request is formed as follows:

GET /rest/pub/opentask/taskID/comments/commentID

To return all comments, the HTTP request is formed as follows:

GET /rest/pub/opentask/taskID/comments

Input Parameters

taskID String The unique identifier that the Task Engine assigns to the task instance.
commentID String Optional. The unique identifier of the comment to be returned.
includeAttachmentData Boolean Optional. Specifies whether or not to include Base64 encoded data in the attachments. Set to:
  • true to include Base64 data.
  • false to omit Base64 data (default).

Output Parameters

taskComments TaskComment[] An array of TaskComment objects that represent the comments retrieved from the task instance. See pub.task:TaskComment for more information about the structure of this object.