Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring comments

Retrieve all comments that were created by a user.

Use the /comments/by-user/{userId} endpoint to fetch all comments that were created by the specified user. Optionally, the query parameter since can be used to fetch comments only 'since' a specific date.<br />User roles: admin, manager, editor, viewer

get/authoring/v1/comments/by-user/{userId}

Path parameters

userIdstring string required

Provide the ID of the user that created the comment.

Query parameters

sincestring date-time

Retrieve only comments newer than this date. The date value must be in the ISO 8601 format YYYY-MM-DD T hh:mm:ss:sssZ.

offsetinteger

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

limitinteger

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'descending' | 'ascending'

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

fieldsstring[]

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.

Response

Successfully lists a paged result view of all comments for the specified userId, optionally filtered by date.

limitinteger required

The page size.

offsetinteger required

The number of items to skip from the beginning of the list.

hrefstring required

A link to the current page.

nextstring

A link to the next page. Only shown if a next page exists.

previousstring

A link to the previous page. Only shown if a previous page exists.

Example response

{
  "limit": 50,
  "href": "/comments?offset=50&limit=50",
  "next": "/comments?offset=100&limit=50",
  "previous": "/comments?offset=0&limit=50",
  "items": [
    {
      "creatorId": "f8c1344e-2296-441b-a8a6-f8d46b72a787",
      "id": "95927bcd-9da3-4d8a-9fbf-ffcabe80a8a4",
      "rev": "2-c839bbb8844549c2e298275c4b2adcb8",
      "message": "More images should be added to slideshow",
      "created": "2017-05-28T22:59:27.610Z",
      "target": {
        "id": "6eac5498-3545-458a-962b-e17742aa7b56",
        "classification": "content"
      },
      "threadId": "b3a18c87-8be0-4938-bba9-98a4cea35200",
      "classification": "Comment",
      "creator": "Krista",
      "lastModifier": "Krista",
      "lastModifierId": "f8c1344e-2296-441b-a8a6-f8d46b72a787",
      "lastModified": "2017-05-28T22:59:27.610Z"
    }
  ]
}