Sign in
Notes

Create a note comment

Creates a comment for a specific note (required scope notes:write)

post/v1/notes/{noteId}/comments

Path parameters

noteIdinteger required

Headers

Customer-Idinteger required

The customer identifier

Request body

commentEntityType'note' | 'assetDefect' required

The type of entity that the note comment is associated to<p>Possible values:</p><ul><li><b>note</b>: Associated with a note entity</li><li><b>assetDefect</b>: Associated with an asset defect entity</li></ul>

entityIdinteger required

The unique identifier of the associated entity that owns the comment, relative to the commentEntityType

noteCommentstring required

The comment body to save

userIdsinteger[]

A list of user IDs to mention in the comment

isPreviousMentionsboolean

When true, the service reuses mentions from the most recent existing comment for the same entity

isMentionsboolean

Enables mention handling for the comment

reaction'like' | 'heart' | 'applause' | 'dislike'

The reaction to a note comment<p>Possible values:</p><ul><li><b>like</b>: Represents a "Like" reaction</li><li><b>heart</b>: Represents a "Heart" reaction</li><li><b>applause</b>: Represents an "Applause" reaction</li><li><b>dislike</b>: Represents a "Dislike" reaction</li></ul>

Example request

{
  "commentEntityType": "note",
  "entityId": 5514123,
  "noteComment": "Example comment",
  "isPreviousMentions": true,
  "isMentions": true,
  "reaction": "like"
}

Response

Created

idinteger required

The unique identifier of the associated entity to retrieve the note comment for

noteIdinteger

The unique identifier of the associated entity that owns the note,

textstring

Free text description about comment

createdAtstring date-time

The dateTime the note comment was created

Example response

{
  "id": 5514123,
  "noteId": 1514123,
  "text": "Sent out the new part",
  "createdAt": "2022-11-29T16:50:16.0000000+00:00"
}

Changes

Changed in 1 of the 5 revisions of this API.1