annotations

Set Annotation Status

post/api/v1/annotations/{annotation_id}/status

Request

Path parameters

annotation_idstring uuid required

Request body

status'accepted' | 'rejected' | 'completed' | 'cancelled' nullable required
row_versioninteger required

Response

Successful Response

idstring uuid required
project_idstring uuid required
page_idstring uuid required
kind'note' | 'text' | 'callout' | 'line' | 'polyline' | 'rect' | 'ellipse' | 'polygon' | 'ink' | 'highlight' | 'stamp' required
subjectstring nullable required
contentsstring nullable required
status'accepted' | 'rejected' | 'completed' | 'cancelled' nullable required
author_idstring uuid nullable required
author_namestring required
author_kind'user' | 'agent' | 'imported' required
visibility'private' | 'project' required
lockedboolean required
bbox_xstring required
bbox_ystring required
bbox_wstring required
bbox_hstring required
display_kindstring required
row_versioninteger required
created_atstring date-time required
updated_atstring date-time required
deleted_atstring date-time nullable required

Changes

No recorded changes to this operation across all 2 revisions of this API.