Endpoint Overview
/api/tasks/v4/tasks/comments/{comment_id}/api/tasks/v4/tasks/{task_id}/comments/api/tasks/v4/tasks/{task_id}/comments/api/tasks/v4/tasks/comments/{comment_id}/api/tasks/v4/tasks/{task_id}/comments/api/tasks/v4/tasks/{task_id}/commentsMarks a task comment as deleted. The task comment resource itself will not be deleted and is still retrievable but certain properties of the task comment will no longer be returned or are masked appropriately.
comment_id stringrequired200 OKDefining a custom starting point by providing the initial_sequence_number offers an optional alternative to the default cursor based pagination.
In combination with the parameters page_limit and the sort parameter it is possible to request comments
in a paginated way starting from a certain sequence number.
Note: The "sequence number" of a comment is the order number within the list of all comments relating to the task.
The parameter initial_sequence_number is used in combination with the parameters page_limit and sort (respectively their default values).
The response is always a paginated list of comments and the returned cursor can be used to navigate further.
initial_sequence_number:** ascending: **
GET api/tasks/v4/tasks/{task_id}/comments?page_limit=10&initial_sequence_number=5&sort=SEQUENCE_NUMBER_ASC
returns a list starting with a comment with sequence_number 5 followed by comments with ascending sequence numbers and at maximum 10 comments (or less if fewer exist).** ascending (via default): **
GET api/tasks/v4/tasks/{task_id}/comments?page_limit=10&initial_sequence_number=5
returns a list starting with a comment with sequence_number 5 followed by comments with ascending sequence numbers and at maximum 10 comments (or less if fewer exist).** descending: **
GET api/tasks/v4/tasks/{task_id}/comments?page_limit=10&initial_sequence_number=20&sort=SEQUENCE_NUMBER_DESC
returns a list starting with a comment with sequence_number maximum 20 followed by comments with descending sequence numbers and at maximum 10 comments (or less if fewer exist).
In cases where there is no comment with sequence number 20, the comment that has the next lower number will be designated as the starting pointtask_id stringrequiredpage_cursor stringA cursor pointing to the first item to be contained in the response array. Refer to our general "pagination" concept for more information.
page_limit integerThe maximum number of items to be contained in the response array. Refer to our general "pagination" concept for more information.
sort string[]initial_sequence_number integerThe query can contain either a initial_sequence_number or a pagination_cursor, but not both.
Alternatively both values can also be null, defaulting to an ascending cursor based pagination.
embed string[]200 OKAdds a new comment to a task.
task_id stringrequiredid stringbody objectRequest body object of TaskComment including plain text and mentions.
attachments object[]a single attachment which shall be attached to an entity
201 Created