Публичный Web API: Создание номенклатуры

Запрос

POST /pub/v1/registrator/nomenclature

Тело запроса (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	CreateNomenclatureRegistrationSettingsRq Настройки регистрации для создания номенклатуры.	Опциональное
registrationSettings.editAfterRegistration	boolean	Включение возможности изменять номер после регистрации	Опциональное
registrationSettings.minLength	uint64	Минимальная длина номера, добавляет лидирующие нули	Опциональное
registrationSettings.reserveEnabled	boolean	Включение резервации номера	Опциональное
registrationSettings.resetInPeriod	boolean	Включение сброса нумерации по периоду	Опциональное
registrationSettings.resetSettings	object	CreateNomenclatureResetSettingsRq Настройки сброса нумерации для создания номенклатуры.	Опциональное
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 Неверные параметры запроса