Patch apiv1documentdocumentsid — contraxsuite-api

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB

document

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

Path parameters

idstring required

A unique integer value identifying this document.

Request body

pkinteger

namestring nullable

document_typestring nullable

file_sizeinteger

folderstring nullable

created_datestring date-time nullable

modified_datestring date-time nullable

modified_by_namestring required

created_by_namestring required

created_by_initialsstring required

created_by_photostring required

modified_by_initialsstring required

modified_by_photostring required

statusinteger nullable

available_statuses_dataobject[]

assigneeinteger nullable

assign_datestring date-time nullable

descriptionstring nullable

titlestring nullable

initial_annotation_idstring

field_valuesobject

field_value_objectsobject

prev_idinteger

next_idinteger

positionstring

documents_countstring

sectionsobject[]

cluster_idstring

was_opened_in_annotatorboolean

user_permissionsobject

Example request

{
  "assign_date": "2000-01-23T04:56:07.000+00:00",
  "user_permissions": "{}",
  "description": "description",
  "created_by_name": "created_by_name",
  "title": "title",
  "created_by_photo": "created_by_photo",
  "status_data": {
    "code": "code",
    "is_active": true,
    "name": "name",
    "id": 5,
    "order": 18471,
    "group": 2
  },
  "available_assignees_data": [
    {
      "initials": "initials",
      "name": "name",
      "last_name": "last_name",
      "photo": "photo",
      "pk": 3,
      "first_name": "first_name",
      "username": "username"
    },
    {
      "initials": "initials",
      "name": "name",
      "last_name": "last_name",
      "photo": "photo",
      "pk": 3,
      "first_name": "first_name",
      "username": "username"
    }
  ],
  "cluster_id": "cluster_id",
  "page_bounds": [
    [
      4.145608029883936,
      4.145608029883936
    ],
    [
      4.145608029883936,
      4.145608029883936
    ]
  ],
  "created_by_initials": "created_by_initials",
  "modified_by_photo": "modified_by_photo",
  "document_type": "document_type",
  "available_statuses_data": [
    "{}",
    "{}"
  ],
  "page_locations": [
    [
      2,
      2
    ],
    [
      2,
      2
    ]
  ],
  "assignee_data": {
    "initials": "initials",
    "name": "name",
    "last_name": "last_name",
    "photo": "photo",
    "pk": 9,
    "first_name": "first_name",
    "username": "username"
  },
  "modified_date": "2000-01-23T04:56:07.000+00:00",
  "file_size": 1294386358,
  "sections": [
    "{}",
    "{}"
  ],
  "field_value_objects": "{}",
  "prev_id": 7,
  "was_opened_in_annotator": true,
  "folder": "folder",
  "name": "name",
  "modified_by_name": "modified_by_name",
  "modified_by_initials": "modified_by_initials",
  "pk": 0,
  "created_date": "2000-01-23T04:56:07.000+00:00",
  "assignee": 7,
  "position": "position",
  "initial_annotation_id": "initial_annotation_id",
  "documents_count": "documents_count",
  "status": 1,
  "field_values": "{}",
  "next_id": 1
}

Response