Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring comments

Create a comment.

Use the /comments endpoint to create a comment. You must provide a message and a target to create the comment.<br />User roles: admin, manager, editor

post/authoring/v1/comments

Request body

messagestring required

The actual comment message.

Example request

{
  "message": "More images should be added to slideshow",
  "target": {
    "id": "6eac5498-3545-458a-962b-e17742aa7b56",
    "classification": "content"
  }
}

Response

Successfully created a comment for an item.

creatorIdstring required

The ID of the user that created the commment.

idstring required

The id of the comment.

revstring required

The revision of the comment.

messagestring required

The actual comment message.

createdstring date-time required

ISO-8601 formatted date.

threadIdstring required

The id string of the thread that this comment belongs to.

classificationstring required

The comment's classification.

kindstring[] required

The "kind" of comment that this is. By default, all comments created by users are "user" comments.

creatorstring required

Display name of the user who created this comment.

lastModifierstring required

The display name of the user who last edited the comment.

lastModifierIdstring required

The ID of the user who last edited the comment.

lastModifiedstring required

The ISO-8601 timestamp that the comment was last modified.

resolvedboolean required

Used for resolving comments during a review. This property is false by default and changes to true when the comment is resolved.

Example response

{
  "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"
}