Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
document
v1

Retrieve DocumentFieldCategory

get/api/v1/document/document-field-categories/{id}/

Path parameters

idstring required

A unique integer value identifying this document field category.

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

idinteger
document_typestring nullable required
document_type_titlestring required
namestring required
orderinteger
fields_numberinteger required
export_keystring uuid

Example response

{
  "name": "name",
  "export_key": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
  "id": 0,
  "fields": [
    {
      "code": "code",
      "id": "id",
      "category": 1,
      "title": "title",
      "order": 19536
    },
    {
      "code": "code",
      "id": "id",
      "category": 1,
      "title": "title",
      "order": 19536
    }
  ],
  "fields_number": 5,
  "document_type_title": "document_type_title",
  "document_type": "document_type",
  "order": 441289069
}