Публичный Web API: Изменение дела

Запрос

PUT /pub/v1/nomenclature/{id}

Параметры пути (path)

Имя параметра	Тип	Описание	Дополнительно
id	uuid	Идентификатор элемента	Обязательный

Тело запроса (body)

Тело запроса принимает ресурс Изменение дела — Request. Содержит следующие доступные для записи свойства:

{
    "directoryId": "uuid",
    "docflow": "string",
    "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"
    }
}

Свойства

Имя	Тип	Описание	Дополнительно
directoryId	uuid	Директория для дела
docflow	string	Документопоток дела (`input`, `output`, `internal`)
name	string	Наименование
registrationSettings	object	Настройки регистрации для изменения дела	Опциональное
registrationSettings.editAfterRegistration	boolean	Включение возможности изменять номер после регистрации	Опциональное
registrationSettings.minLength	uint64	Минимальная длина номера, добавляет лидирующие нули	Опциональное
registrationSettings.reserveEnabled	boolean	Включение резервирования номера	Опциональное
registrationSettings.resetInPeriod	boolean	Включение периодического сброса нумерации	Опциональное
registrationSettings.resetSettings	object	Настройки сброса нумерации для изменения дела	Опциональное
registrationSettings.resetSettings.nextResetAt	date-time	Дата ближайшего сброса нумерации	Опциональное
registrationSettings.resetSettings.resetPeriod	string	Единица сброса нумерации Возможные значения: `year`, `month`, `week`, `day`	Опциональное
registrationSettings.resetSettings.resetPeriodCount	int64	Количество единиц в периоде сброса нумерации, например нумерация может сбрасываться каждые 3 недели (`3 week`)	Опциональное
registrationSettings.template	string	Шаблон для номера, по умолчанию устанавливать `{$__index}`	Опциональное
registrationSettings.templateEnabled	boolean	Включение автоматического режима	Опциональное
registrationSettings.through	boolean	Включение сквозной нумерации	Опциональное
registrationSettings.throughSerialId	uuid	Идентификатор сквозной нумерации	Опциональное

Авторизация

Запрос обязательно должен использовать один из следующих методов авторизации: API key

Ответ

Могут быть возвращены следующие коды состояния HTTP:

HTTP-статус	Описание	Модель ответа
200	OK Модель ответа на изменение дела	Модель ответа на изменение дела (Изменение дела)
400	Bad Request Неверные параметры запроса