Методы

  • GET — Получение списка дел

Ресурс

{
    "error": "string",
    "result": [
        {
            "createdAt": "date-time",
            "createdBy": "uuid",
            "deletedAt": "date-time",
            "directoryId": "uuid",
            "docflow": "string",
            "id": "uuid",
            "name": "string",
            "registrationSettings": {
                "editAfterRegistration": "boolean",
                "minLength": "uint64",
                "reserveEnabled": "boolean",
                "resetInPeriod": "boolean",
                "resetSettings": {
                    "nextResetAt": "date-time",
                    "resetPeriod": "string",
                    "resetPeriodCount": "int64"
                },
                "template": "string",
                "templateEnabled": "boolean",
                "through": "boolean",
                "throughSerialId": "uuid"
            },
            "serialId": "uuid",
            "updatedAt": "date-time",
            "updatedBy": "uuid"
        }
    ],
    "success": "boolean"
}

Свойства

Имя Тип Описание Дополнительно
error string

Текст ошибки, если success == false

Опциональное
result[] array

Контекст с данными

Опциональное
result[].createdAt date-time

Когда создано дело

Опциональное
result[].createdBy uuid

Кто создал дело

Опциональное
result[].deletedAt date-time

Когда удалено дело, при отсутствии — активно

Опциональное
result[].directoryId uuid

Директория, в которой находится дело

Опциональное
result[].docflow string

Документопоток дела (input, output, internal)

Опциональное
result[].id uuid

Идентификатор

Опциональное
result[].name string

Название

Опциональное
result[].registrationSettings object

Настройки регистрации дела

Опциональное
result[].registrationSettings.editAfterRegistration boolean

Включение возможности изменять номер после регистрации

Опциональное
result[].registrationSettings.minLength uint64

Минимальная длина номера, добавляет лидирующие нули

Опциональное
result[].registrationSettings.reserveEnabled boolean

Включение резервирования номера

Опциональное
result[].registrationSettings.resetInPeriod boolean

Включение периодического сброса нумерации

Опциональное
result[].registrationSettings.resetSettings object

Настройки сброса нумерации

Опциональное
result[].registrationSettings.resetSettings.nextResetAt date-time

Дата ближайшего сброса нумерации

Опциональное
result[].registrationSettings.resetSettings.resetPeriod string

Единица сброса нумерации
Возможные значения: year, month, week, day

Опциональное
result[].registrationSettings.resetSettings.resetPeriodCount int64

Количество единиц в периоде сброса нумерации, например нумерация может сбрасываться каждые 3 недели (3 week)

Опциональное
result[].registrationSettings.template string

Шаблон для номера, по умолчанию устанавливать {$__index}

Опциональное
result[].registrationSettings.templateEnabled boolean

Включение автоматического режима

Опциональное
result[].registrationSettings.through boolean

Включение сквозной нумерации

Опциональное
result[].registrationSettings.throughSerialId uuid

Идентификатор сквозной нумерации

Опциональное
result[].serialId uuid

Идентификатор нумератора

Опциональное
result[].updatedAt date-time

Когда изменено дело

Опциональное
result[].updatedBy uuid

Кто изменил дело

Опциональное
success boolean

Признак успешного запроса

Опциональное