GeneratePrintFormPng

Запускает генерацию печатной формы документа в формате PNG.

Метод создает задачу на печать и возвращает ее идентификатор.

Чтобы получить печатную форму в формате PDF, используйте метод GeneratePrintForm.

POST /GeneratePrintFormPng
Query Parameters:

  • boxId – идентификатор ящика организации в формате GUID.

  • messageId – идентификатор сообщения.

  • documentId – идентификатор документа в сообщении, для которого нужно сгенерировать печатную форму.

Request Headers:
Status Codes:

  • 200 OK – операция успешно завершена.

  • 400 Bad Request – данные в запросе имеют неверный формат или отсутствуют обязательные параметры.

  • 401 Unauthorized – в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.

  • 402 Payment Required – у указанного ящика закончилась подписка на API.

  • 403 Forbidden – доступ к ящику с предоставленным авторизационным токеном запрещен или у пользователя недостаточно прав для доступа к указанному документу.

  • 404 Not Found – не найден ящик с указанным идентификатором, не найдено сообщение с идентификатором messageId или не найдена сущность с идентификатором documentId.

  • 405 Method Not Allowed – используется неподходящий HTTP-метод.

  • 500 Internal Server Error – при обработке запроса возникла непредвиденная ошибка.

Response Body:

Тело ответа содержит идентификатор операции taskId в структуре AsyncMethodResult. По этому идентификатору с помощью метода GetGeneratedPrintFormResult можно узнать результат обработки запроса.

В отличие от печатной формы в формате PDF, каждый PNG-файл содержит одну страницу документа.

Повторный вызов метода для того же документа в течение 7 дней вернет идентификатор уже существующей задачи, а не создаст новую. Если между одинаковыми вызовами прошло больше 7 дней, метод создаст новую задачу.

Результат генерации может получить любой пользователь методом GetGeneratedPrintFormResult. Но скачать PNG-файлы с полки документов методом ShelfDownload (V2) может только тот пользователь, который запустил печать.

Примеры использования

Пример HTTP-запроса:

POST /GeneratePrintFormPng?boxId={{boxId}}&messageId={{messageId}}&documentId={{documentId}} HTTP/1.1
Host: diadoc-api.kontur.ru
Authorization: Bearer {{access_token}}
Accept: application/json; charset=utf-8

Пример тела ответа:

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
    "TaskId": "2fd45887-138e-4e08-aeb2-bcd55bf0dd85"
}

См. также

Инструкции:
Методы для работы с печатными формами:

  • DetectCustomPrintForms — определяет нестандартную печатную форму для документов из указанного списка

  • GenerateDocumentProtocol — генерирует печатную форму протокола передачи документа и подпись к ней

  • GenerateDocumentZip — формирует ZIP-архив, содержащий файлы документооборота указанного документа

  • GeneratePrintForm — генерирует печатную форму документа в формате PDF

  • GeneratePrintFormFromAttachment — возвращает идентификатор, с помощью которого можно получить печатную форму документа в формате PDF по его содержимому

  • GeneratePrintFormPng — запускает генерацию печатной формы документа в формате PNG

  • GeneratePrintFormPngFromAttachment — запускает генерацию печатной формы документа в формате PNG по его содержимому

  • GetGeneratedPrintForm — генерирует печатную форму документа по идентификатору, полученному методом GeneratePrintFormFromAttachment

  • GetGeneratedPrintFormResult — возвращает статус и результат генерации печатной формы