Sign in

v1

latestOpenAPI 3.0.22026-07-17373198641.7 KB
document
v1

Document Type List

get/api/v1/document/document-types/

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

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.

search_fieldsstring[]
editor_type'save_by_field' | 'save_all_fields_at_once'
created_by__namestring
created_datestring date-time
modified_by__namestring
modified_datestring date-time
metadataobject nullable
fields_numberinteger required
managersinteger[]

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

Example response

[
  {
    "metadata": "{}",
    "code": "code",
    "fields_data": [
      {
        "classifier_init_script": "classifier_init_script",
        "vectorizer_stop_words": "vectorizer_stop_words",
        "metadata": "{}",
        "code": "code",
        "allow_values_not_specified_in_choices": true,
        "description": "description",
        "modified_by__name": "modified_by__name",
        "long_code": "long_code",
        "title": "title",
        "type": "address",
        "value_regexp": "value_regexp",
        "trained_after_documents_number": 314780941,
        "unsure_choice_value": "unsure_choice_value",
        "uid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "read_only": true,
        "depends_on_fields": [
          "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        ],
        "value_aware": true,
        "requires_text_annotations": true,
        "created_by__name": "created_by__name",
        "hide_until_python": "hide_until_python",
        "document_type": "document_type",
        "order": 19750,
        "convert_decimals_to_floats_in_formula_args": true,
        "dirty": true,
        "confidence": "High",
        "hide_until_js": "hide_until_js",
        "default_value": "{}",
        "value_detection_strategy_name": "value_detection_strategy_name",
        "modified_date": "2000-01-23T04:56:07.000+00:00",
        "unsure_thresholds_by_value": "{}",
        "text_unit_type": "sentence",
        "mlflow_model_uri": "mlflow_model_uri",
        "document_type__title": "document_type__title",
        "display_yes_no": true,
        "training_finished": true,
        "mlflow_detect_on_document_level": true,
        "formula": "formula",
        "value_detection_strategy": "disabled",
        "hidden_always": true,
        "created_date": "2000-01-23T04:56:07.000+00:00",
        "category": {
          "name": "name",
          "id": 0,
          "order": 441289069
        },
        "family": 0,
        "choices": [
          "choices",
          "choices"
        ],
        "is_value_detection_strategy_disabled": true
      },
      {
        "classifier_init_script": "classifier_init_script",
        "vectorizer_stop_words": "vectorizer_stop_words",
        "metadata": "{}",
        "code": "code",
        "allow_values_not_specified_in_choices": true,
        "description": "description",
        "modified_by__name": "modified_by__name",
        "long_code": "long_code",
        "title": "title",
        "type": "address",
        "value_regexp": "value_regexp",
        "trained_after_documents_number": 314780941,
        "unsure_choice_value": "unsure_choice_value",
        "uid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
        "read_only": true,
        "depends_on_fields": [
          "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
          "046b6c7f-0b8a-43b9-b35d-6489e6daee91"
        ],
        "value_aware": true,
        "requires_text_annotations": true,
        "created_by__name": "created_by__name",
        "hide_until_python": "hide_until_python",
        "document_type": "document_type",
        "order": 19750,
        "convert_decimals_to_floats_in_formula_args": true,
        "dirty": true,
        "confidence": "High",
        "hide_until_js": "hide_until_js",
        "default_value": "{}",
        "value_detection_strategy_name": "value_detection_strategy_name",
        "modified_date": "2000-01-23T04:56:07.000+00:00",
        "unsure_thresholds_by_value": "{}",
        "text_unit_type": "sentence",
        "mlflow_model_uri": "mlflow_model_uri",
        "document_type__title": "document_type__title",
        "display_yes_no": true,
        "training_finished": true,
        "mlflow_detect_on_document_level": true,
        "formula": "formula",
        "value_detection_strategy": "disabled",
        "hidden_always": true,
        "created_date": "2000-01-23T04:56:07.000+00:00",
        "category": {
          "name": "name",
          "id": 0,
          "order": 441289069
        },
        "family": 0,
        "choices": [
          "choices",
          "choices"
        ],
        "is_value_detection_strategy_disabled": true
      }
    ],
    "search_fields": [
      "search_fields",
      "search_fields"
    ],
    "modified_by__name": "modified_by__name",
    "title": "title",
    "modified_date": "2000-01-23T04:56:07.000+00:00",
    "uid": "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
    "created_by__name": "created_by__name",
    "created_date": "2000-01-23T04:56:07.000+00:00",
    "categories": [
      {
        "name": "name",
        "id": 5,
        "order": -1158723813
      },
      {
        "name": "name",
        "id": 5,
        "order": -1158723813
      }
    ],
    "fields_number": 5,
    "editor_type": "save_by_field",
    "managers": [
      7,
      7
    ]
  }
]