Response model for getting document categorization directory (Getting list of document categorization directories)

Methods

  • GET — Getting list of document categorization directories

Resource

{
    "error": "string",
    "result": [
        {
            "createdAt": "date-time",
            "createdBy": "uuid",
            "deletedAt": "date-time",
            "directoryId": "uuid",
            "id": "uuid",
            "name": "string",
            "type": "string",
            "updatedAt": "date-time",
            "updatedBy": "uuid"
        }
    ],
    "success": "boolean"
}

Properties

Name Type Description Additional
error string

Error text if success == false

 Optional
result[] array

Context with data

 Optional
result[].createdAt date-time

When the document categorization directory was created

 Optional
result[].createdBy uuid

Document categorization directory created by

 Optional
result[].deletedAt date-time

In case document registration directory is deleted, if absent - active

 Optional
result[].directoryId uuid

Directory where the document categorization directory is located

 Optional
result[].id uuid

Identifier

 Optional
result[].name string

Name

 Optional
result[].type string

Directory type

Possible values are:

  • place
  • section
 Optional
result[].updatedAt date-time

When the document categorization directory was changed

 Optional
result[].updatedBy uuid

Document categorization directory changed by

 Optional
success boolean

Successful request flag

 Optional