document
v1

POST /api/v1/document/document-field-categories/

Changed on

Create DocumentFieldCategory

Params:
    - document_type: uid
    - name: str - Verbose name for field category, max 100 symbols
    - order: int
    - fields: array of field uids

Request

Request body

idinteger
document_typestring nullable required
namestring required
orderinteger required
fieldsstring[] nullable
fields_numberinteger

Example request

{
  "name": "name",
  "id": 0,
  "fields": [
    "fields",
    "fields"
  ],
  "fields_number": 1,
  "document_type": "document_type",
  "order": 441289069
}

Response

idinteger
document_typestring nullable required
namestring required
orderinteger required
fieldsstring[] nullable
fields_numberinteger

Example response

{
  "name": "name",
  "id": 0,
  "fields": [
    "fields",
    "fields"
  ],
  "fields_number": 1,
  "document_type": "document_type",
  "order": 441289069
}

Changes

    • breaking

      the / request property type changed from no type to string (media type: application/json)

    • breaking

      the response property became nullable for the status

    • breaking

      the / response's property type changed from no type to string for status

    • info

      the request property became nullable (media type: application/json)

    • info

      the request property became nullable (media type: application/x-www-form-urlencoded)

    • info

      the request property became nullable (media type: multipart/form-data)

    • info

      the / request property type was generalized from no type to string (media type: application/x-www-form-urlencoded)

    • info

      the / request property type was generalized from no type to string (media type: multipart/form-data)

    • breaking

      the request property became not nullable (media type: application/json)

    • breaking

      the request property became not nullable (media type: application/x-www-form-urlencoded)

    • breaking

      the request property became not nullable (media type: multipart/form-data)

    • breaking

      the / request property type changed from string to no type (media type: application/json)

    • breaking

      the / response's property type changed from string to no type for status

    • info

      the / request property type was generalized from string to no type (media type: application/x-www-form-urlencoded)

    • info

      the / request property type was generalized from string to no type (media type: multipart/form-data)