Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
document
v1

Update Annotation (Document Field Value)

put/api/v1/document/annotations/{id}/

Path parameters

idstring required

A unique integer value identifying this field annotation.

Request body

pkinteger
documentinteger required
fieldstring required
valueobject nullable required
location_startinteger nullable required
location_endinteger nullable required
location_textstring nullable
modified_byinteger nullable
modified_datestring date-time

Example request

{
  "location_start": 314780940,
  "field": "field",
  "document": 6,
  "modified_by": 5,
  "location_end": 1280358508,
  "pk": 0,
  "modified_date": "2000-01-23T04:56:07.000+00:00",
  "value": "{}",
  "location_text": "location_text"
}

Response

pkinteger
documentinteger required
fieldstring required
valueobject nullable required
location_startinteger nullable required
location_endinteger nullable required
location_textstring nullable
modified_byinteger nullable
modified_datestring date-time

Example response

{
  "location_start": 314780940,
  "field": "field",
  "document": 6,
  "modified_by": 5,
  "location_end": 1280358508,
  "pk": 0,
  "modified_date": "2000-01-23T04:56:07.000+00:00",
  "value": "{}",
  "location_text": "location_text"
}