POST api/file/{FileId}/annotation

Adds one or more annotations to a specified document file.

Request Information

URI Parameters

Name	Description	Type	Additional information
FileId	The internal node ID of the document to annotate. Must be a valid, non-deleted document with appropriate access rights.	integer	Required

Body Parameters

A list of annotation objects to be added. Each annotation must include properties such as `text`, `page`, `type`, `x`, `y`, `width`, `height`, `color`, `priority`, and `status`.

Collection of Annotation

Name	Description	Type	Additional information
page	Page	integer	None.
type	Annotation Type - rectangle, circle, dot	string	None.
xCoodinate	Annotation X Coordinate	decimal number	None.
yCoodinate	Annotation Y Coordinate	decimal number	None.
width	Annotation Width	decimal number	None.
height	Annotation Height	decimal number	None.
text	Annotation Text	string	None.
color	Annotation Colour (RGB)	string	None.
priority	Annotation Text	boolean	None.
status	Annotation Status	string	None.
systemAnnotation	System Annotation	boolean	None.

Request Formats

application/json, text/json, application/scim+json

Sample:

[
  {
    "page": 1,
    "type": "sample string 2",
    "xCoodinate": 3.1,
    "yCoodinate": 4.1,
    "width": 5.1,
    "height": 6.1,
    "text": "sample string 7",
    "color": "sample string 8",
    "priority": true,
    "status": "sample string 10",
    "systemAnnotation": true
  },
  {
    "page": 1,
    "type": "sample string 2",
    "xCoodinate": 3.1,
    "yCoodinate": 4.1,
    "width": 5.1,
    "height": 6.1,
    "text": "sample string 7",
    "color": "sample string 8",
    "priority": true,
    "status": "sample string 10",
    "systemAnnotation": true
  }
]

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'List`1'.

Response Information

Resource Description

On success: HTTP 200 OK. On failure: HTTP 400 Bad Request if the file is invalid or access is denied.

Collection of integer

Response Formats

application/json, text/json, application/scim+json

Sample:

[
  1,
  2
]