Retrieve all comments for a specific item.

get

https://example.com/authoring/v1/comments/by-item/{classification}/{id}

Use the /comments/by-item/{classification}/{id} endpoint to fetch all comments that are associated to a specific item. Use the query parameter 'since' to fetch comments since a specific date. Conditional requests are supported.
User roles: admin, manager, editor, viewer

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

classification

string

required

Provide the classification of the item for which you want to retrieve the comments.

string

required

Provide ID of the item for which you want to retrieve the comments.

Query Params

since

date-time

Provide the date from when to retrieve comments. Only comments that were added after this date are retrieved. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.

offset

integer

Defaults to 0

Use the offset parameter to specify the number of comments to skip from the beginning of the list and return the rest.

limit

integer

Defaults to 50

Set the limit for the maximum number of comments to return in a single result. The maximum number of comments that are returned by default is 50.

order

string

enum

Defaults to descending

Specify whether you want the comments to be returned in ascending or descending order. Comments are returned in descending order by default.

Allowed:

fields

array of strings

Only the comment properties that are specified here are returned for each result. Any comment property is a valid value and can be specified in a comma-separated list. For example, to show only the comment properties message and creatorId, provide the values of message and creatorId. All comment properties are returned by default.

fields

Responses

304

The Etag value that is provided in the If-None-Match header corresponds to the recent version.

200Successfully lists a paged result view of all comments for the given item, optionally filtered by date.

429Too Many Requests, the server has reached a limit, the request must be sent again at a later time.

503Unable to list the comments in the database as the service is unavailable. Try again later.

defaultUnexpected error.