PDF документы
Группа сообщений для работы с PDF документами.
Командные модели
Данный блок содержит описание основных командных моделей, отвечающих за выполнение действий.
createPDFCommandEvent
Команда для генерации печатной формы (PDF) документооборота. После генерации PDF документ будет сохранен в ЕСХ.
Примечания: для создания печатной формы требуется заполнить поле
uid, либоdocflowId. Если оба поля будут одновременно заполненными или пустыми, то будет ошибка.
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
requestId | Да | uuid | ИД запроса |
uid | Нет | uuid | УИД ГИС ЭПД |
docflowId | Нет | uuid | ИД документооборота |
layout | Нет | PDFLayout | Тип шаблона (по умолчанию: default) |
Примеры валидных моделей:
Пример модели 0
{
"requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
"uid": "d74a7312-41bc-452e-8843-580d53059527",
"layout": "full"
}
Пример модели 1
{
"requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
"docflowId": "O9596552-364A-402E-AFFE-7C01F9C1B449",
"layout": "full"
}
Ответные модели
createPDFOutboundEvent.
Ответное сообщение для события createPDFCommandEvent.
| Название | Обязательность | Тип | Описание |
|---|---|---|---|
requestId | Да | uuid | ИД запроса |
storageId | Да | uuid | Идентификатор PDF документа в ЕСХ (результат генерации) |
userError | Нет | userError | Содержит описание ошибки (заполняется только в случае возникновения ошибки). Если данное поле не заполнена, значит все удачно отработало |
Пример модели
{
"requestId": "a8b53313-4603-4988-a91b-b313d262a6a6",
"storageId": "fd2d0466-cf48-4028-8531-eb90168885d3"
}
Типы данных
Данный блок содержит описание кастомных типов данных.
PDFLayout
Типы шаблонов для генерации печатных форм.
| Значение | Описание |
|---|---|
| default | стандартный шаблон печатной формы |
| full | расширенный шаблон печатной формы |