Методы

  • POST — Создание дела

Ресурс

{
    "error": "string",
    "item": {
        "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

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

Дело

Опциональное
item.createdAt date-time

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

Опциональное
item.createdBy uuid

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

Опциональное
item.deletedAt date-time

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

Опциональное
item.directoryId uuid

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

Опциональное
item.docflow string

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

Опциональное
item.id uuid

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

Опциональное
item.name string

Название

Опциональное
item.registrationSettings object

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

Опциональное
item.registrationSettings.editAfterRegistration boolean

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

Опциональное
item.registrationSettings.minLength uint64

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

Опциональное
item.registrationSettings.reserveEnabled boolean

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

Опциональное
item.registrationSettings.resetInPeriod boolean

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

Опциональное
item.registrationSettings.resetSettings object

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

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

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

Опциональное
item.registrationSettings.resetSettings.resetPeriod string

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

Опциональное
item.registrationSettings.resetSettings.resetPeriodCount int64

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

Опциональное
item.registrationSettings.template string

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

Опциональное
item.registrationSettings.templateEnabled boolean

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

Опциональное
item.registrationSettings.through boolean

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

Опциональное
item.registrationSettings.throughSerialId uuid

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

Опциональное
item.serialId uuid

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

Опциональное
item.updatedAt date-time

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

Опциональное
item.updatedBy uuid

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

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

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

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