Get comment: GET /Instances/{Id}/Comments
Get all or specific comments
| VERB | Header | Resource/Id/ Selector | Description | Parameters | Return data |
| GET | Ticket | /Instances/{Id}/ Comments | List all comments for the instance. | id (guid), pageIndex (int), pageSize (int) | totalRecords (int), pageIndex (int), pageSize(int), comments (CommentResult[]) |
| GET | Ticket | /Instances/{Id}/ Comments/ {CommentId} | Get a specific comment. | id (guid), commentId (guid) | commentId (guid), authorSecurityId (string), author (string), childComments (CommentResult[]), created (date), edited (date), text (string), isViewed (bool), objectId (guid), objectName (string), objectType (string), parentCommentId (guid) |
Post a comment: POST /Instances/{Id}/Comments
Create a new instance comment or reply to another comment
| VERB | Header | Resource/Id/ Selector | Description | Parameters | Return data |
| POST | Ticket | /Instances/{Id}/ Comments | Create a comment | text (string), parentCommentID (guid) | commentId (guid), authorSecurityId (string), author (string), childComments (CommentResult[]), created (date), edited (date), text (string), isViewed (bool), objectId (guid), objectName (string), objectType (string), parentCommentId (guid) |
Delete comment: DELETE /Instances/{Id}/Comments/{CommentId}
Delete a comment
| VERB | Header | Resource/Id/ Selector | Description | Parameters | Return data |
| DELETE | Ticket | /Instances/{Id}/ Comments/ {CommentId} | Delete a specific comment | id (guid), commentID (guid) |
Get comment for an instance object: GET /Instances/{Id}/Objects/{ObjectId}/Comments
Get all or specific comment for an instance object
| VERB | Header | Resource/Id/ Selector | Description | Parameters | Return data |
| GET | Ticket | /Instances/{Id}/ Objects/{ObjectId}/ Comments | List all comments for the instance object. | id (guid), pageIndex (int), pageSize (int) | totalRecords (int), pageIndex (int), pageSize(int), comments (CommentResult[]) |
| GET | Ticket | /Instances/{Id}/ Objects/{ObjectId}/ Comments/ {CommentId} | Get a specific comment for the instance object. | id (guid), commentId (guid) | commentId (guid), authorSecurityId (string), author (string), childComments (CommentResult[]), created (date), edited (date), text (string), isViewed (bool), objectId (guid), objectName (string), objectType (string), parentCommentId (guid) |
Post a comment on an instance object: POST /Instances/{Id}/Objects/{ObjectId}/Comments
Create a new instance comment on an instance object or reply to another comment on an instance object
| VERB | Header | Resource/Id/ Selector | Description | Parameters | Return data |
| POST | Ticket | /Instances/{Id}/ Objects/{ObjectId}/ Comments | Create a comment for an instance object | text (string), parentCommentID (guid) | commentId (guid), authorSecurityId (string), author (string), childComments (CommentResult[]), created (date), edited (date), text (string), isViewed (bool), objectId (guid), objectName (string), objectType (string), parentCommentId (guid) |
Delete comment from an instance object: DELETE /Instances/{Id}/Comments/{CommentId}
Delete a comment for a specific instance object
| VERB | Header | Resource/Id/ Selector | Description | Parameters | Return data |
| DELETE | Ticket | /Instances/{Id}/ Comments/ {CommentId} | Delete a specific comment for an instance object | id (guid), commentID (guid) |