Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
document
v1

Field Annotation Details (not Field Annotation False Match)

get/api/v1/document/project/{project_pk}/document-field-annotations/{uid}/

Path parameters

project_pkstring required
uidstring required

Query parameters

jq_filtersobject

Filter params similar to JQWidgets grid filter params: filterscount=1, filterdatafield0="a", filtervalue0="b", filtercondition0="CONTAINS", filteroperator0=1, sortdatafied="c", sortorder="asc"

Response

pkinteger
uidstring uuid
project_idinteger
project_namestring
document_idstring
document_namestring
document_typestring
document_statusstring
field_idstring
field_namestring
valueobject nullable
location_startinteger nullable
location_endinteger nullable
location_textstring nullable
assignee_idinteger required
assign_datestring date-time nullable
status_idinteger required
status_namestring
assignee_namestring
modified_by_idstring
modified_datestring date-time

Example response

{
  "field_id": "field_id",
  "assign_date": "2000-01-23T04:56:07.000+00:00",
  "status_name": "status_name",
  "modified_by_id": "modified_by_id",
  "project_name": "project_name",
  "document_id": "document_id",
  "modified_date": "2000-01-23T04:56:07.000+00:00",
  "assignee_name": "assignee_name",
  "field_name": "field_name",
  "uid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "document_name": "document_name",
  "location_start": 314780940,
  "status_id": 2,
  "project_id": 6,
  "document_status": "document_status",
  "location_end": 1280358508,
  "pk": 0,
  "value": "{}",
  "location_text": "location_text",
  "document_type": "document_type",
  "assignee_id": 5
}