PATCH /api/v1/document/documents/:id/fields — contraxsuite-api

document

patch/api/v1/document/documents/{id}/fields/

Path parameters

idstring required

A unique integer value identifying this document.

Request body

pkinteger

namestring nullable

document_typestring nullable

file_sizeinteger

folderstring nullable

statusinteger nullable

available_statuses_datastring

assigneeinteger nullable

assign_datestring date-time nullable

available_assignees_datastring

descriptionstring nullable

titlestring nullable

initial_annotation_idstring

page_locationsstring

field_valuesstring

field_value_objectsstring

prev_idstring

next_idstring

sectionsstring

cluster_idstring

user_permissionsstring

Example request

{
  "assign_date": "2000-01-23T04:56:07.000+00:00",
  "available_statuses_data": "available_statuses_data",
  "notes": [
    {
      "field_id": "field_id",
      "note": "note",
      "location_start": -1618552611,
      "location_end": -1707401670,
      "pk": 2,
      "field_value_id": 6,
      "document_id": 1,
      "user": {
        "role": 7,
        "name": "name",
        "last_name": "last_name",
        "photo": "photo",
        "pk": 4,
        "first_name": "first_name",
        "username": "username"
      },
      "timestamp": "2000-01-23T04:56:07.000+00:00"
    },
    {
      "field_id": "field_id",
      "note": "note",
      "location_start": -1618552611,
      "location_end": -1707401670,
      "pk": 2,
      "field_value_id": 6,
      "document_id": 1,
      "user": {
        "role": 7,
        "name": "name",
        "last_name": "last_name",
        "photo": "photo",
        "pk": 4,
        "first_name": "first_name",
        "username": "username"
      },
      "timestamp": "2000-01-23T04:56:07.000+00:00"
    }
  ],
  "user_permissions": "user_permissions",
  "description": "description",
  "page_locations": "page_locations",
  "assignee_data": {
    "role": 3,
    "name": "name",
    "last_name": "last_name",
    "photo": "photo",
    "pk": 9,
    "first_name": "first_name",
    "username": "username"
  },
  "title": "title",
  "file_size": 1294386358,
  "status_data": {
    "code": "code",
    "is_active": true,
    "name": "name",
    "id": 5,
    "order": 18471,
    "group": 2
  },
  "sections": "sections",
  "available_assignees_data": "available_assignees_data",
  "field_value_objects": "field_value_objects",
  "prev_id": "prev_id",
  "cluster_id": "cluster_id",
  "folder": "folder",
  "name": "name",
  "pk": 0,
  "assignee": 7,
  "initial_annotation_id": "initial_annotation_id",
  "document_type": "document_type",
  "status": 1,
  "field_values": "field_values",
  "next_id": "next_id"
}

Response