resources/comments (post)

To add a new comment to either a segment or a document. Comments can indeed be attached to different objects.

URL

(POST) /resources/comments

PARAMETERS

The parameters are a JSON object included in the request body:

scope

The scope object. The segment must be within the scope.

Mandatory
cty

Type of comment to add:

  • "s": Segment level comment. Provide sid parameter below.
  • "d": Document level comment. Provide did parameter below.
Mandatory
sidThe segment id. Required if you add a segment level comment.Optional
didThe document id. Required if you add a document level comment.Optional
txt

The comment text. Plain text.

Mandatory
loc

The locale to which the comment is attached. This can be a source or target locale.

Mandatory
catOptionally, the comments category. Defines the category (a name) as well as visual style.Optional
solved

The comment status if it's solved or not. (true) means the comment is solved. (false) means the comment is not solved.

Sending the value as null or not sending it (the system will set it to false by default).

Optional


RESULTS

A JSON object with the full comment details. See Comment (Object) for details.



Copyright Wordbee - Buzzin' Outside the Box since 2008