Comment Object
Contains information about a comment on a Board item such as a ticket, discussion, or alert.
This object is used by the following operations:
- POST /api/discussions/{DiscussionID}/comments (to comment on a discussion)
- POST /api/tickets/{TicketID}/comments (to comment on a ticket)
- POST /api/alerts/{AlertID}/comments (to comment on an alert)
- Operations that reference the Comments object
- Operations that reference the CommentDetail object
The properties included in the Comment object are listed below.
| Property | Type | Description |
|---|---|---|
| CommentID | string | The unique ID for a specific comment. |
| CommentSubjectID | string | The unique ID for a specific comment subject. |
| Content | string | The content of the comment. |
| Created | dateTime | The date/time stamp when the resource was first created. Used only in response messages. |
| Marks | integer | The number of marks on the resource. |
| IsMarked | boolean | Indicates whether there are any marks on the resource or not. |
| UserID | string | The unique ID for a specific user. |
| UserName | string | The username for the user who created the comment. |
| AvatarURL | anyURI | URL for the avatar uploaded for the resource, if any. Used only in response messages. |
| Published | boolean | Indicates whether the comment is published. |
| WorkflowState | string | The workflow state that the resource is currently in, if it is governed by a workflow. |
| MediaType | string | Indicates the media type for a comment associated with a Board item. Valid values: text/markdown (the default if platform settings support markdown) or text/plain (the default if markdown is not supported). |
| BoardItemArtifacts | BoardItemArtifacts | Contains information about an image or other artifact associated with a Board item. Applicable only if the DescriptionMediaType for the Board item is text/markdown. |
