Put apiv1documentdocument typesuid — contraxsuite-api

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB

document

Fill in "self.action_message" attribute to use later to save Action.message (see dispatch method)

put/api/v1/document/document-types/{uid}/

Path parameters

uidstring required

A UUID string identifying this document type.

Request body

uidstring uuid

titlestring required

codestring required

Field codes must be lowercase, should start with a Latin letter, and contain only Latin letters, digits, and underscores.

managersinteger[]

Choose which users can modify this Document Type. Users chosen as Managers can be of any System-Level Permission.

search_fieldsstring[]

editor_type'save_by_field' | 'save_all_fields_at_once' required

field_code_aliasesobject nullable

metadataobject nullable

warning_messagestring

Example request

{
  "warning_message": "warning_message",
  "uid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "metadata": "{}",
  "code": "code",
  "search_fields": [
    "search_fields",
    "search_fields"
  ],
  "field_code_aliases": "{}",
  "categories": [
    {
      "name": "name",
      "id": 5,
      "order": -1158723813
    },
    {
      "name": "name",
      "id": 5,
      "order": -1158723813
    }
  ],
  "title": "title",
  "fields": [
    {
      "code": "code",
      "id": "id",
      "category": 1,
      "title": "title",
      "order": 19536
    },
    {
      "code": "code",
      "id": "id",
      "category": 1,
      "title": "title",
      "order": 19536
    }
  ],
  "managers": [
    0,
    0
  ],
  "editor_type": "save_by_field"
}

Response