Перейти к основному содержимому

GetGeneratedPrintFormResult

Возвращает статус и результат генерации печатной формы документа, запущенной методом GeneratePrintFormPng или GeneratePrintFormPngFromAttachment.

GET /GetGeneratedPrintFormResult

Параметры запроса

Заголовки запроса

Коды ответа

  • 200 — операция успешно завершена.
  • 400 — данные в запросе имеют неверный формат или отсутствуют обязательные параметры.
  • 401 — в запросе отсутствует HTTP-заголовок Authorization или в этом заголовке содержатся некорректные авторизационные данные.
  • 402 — у указанного ящика закончилась подписка на API.
  • 403 — доступ к ящику с предоставленным авторизационным токеном запрещен или результат генерации по содержимому документа запрашивает не тот пользователь, который запустил печать.
  • 404 — не найден ящик или операция с указанными идентификаторами.
  • 405 — используется неподходящий HTTP-метод.
  • 429 — превышено ограничение на количество запросов в единицу времени.
  • 500 — при обработке запроса возникла непредвиденная ошибка.

Тело ответа

Тело ответа содержит результат генерации печатной формы, представленный структурой GeneratedPrintFormResult.

Если генерация завершилась успешно, в поле Files будет список имен PNG-файлов на полке документов. Каждый файл соответствует одной странице документа. Скачать файлы можно методом ShelfDownload (V2).

Метод работает по следующим правилам:

  • Если печать запущена методом GeneratePrintFormPng, результат может получить любой пользователь. Скачать PNG-файлы с полки методом ShelfDownload (V2) может только тот пользователь, который запустил печать.
  • Если печать запущена методом GeneratePrintFormPngFromAttachment, результат может получить только тот пользователь, который запустил печать. Иначе метод вернет ошибку 403 (Forbidden).

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

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

GET /GetGeneratedPrintFormResult?boxId={{boxId}}&taskId={{taskId}} 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

    {
    "OperationStatus": "InProgress",
    "Files": [],
    "Errors": []
    }
  • Операция завершена успешно

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

    {
    "OperationStatus": "Success",
    "Files": [
    "dd-api-6831e2e9-cc81-48d5-807d-fe51c2037d44",
    "dd-api-7b2c91a0-1e4f-4d8a-9c33-0a1b2c3d4e5f"
    ],
    "Errors": []
    }
  • Операция завершилась с ошибкой

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

    {
    "OperationStatus": "Failed",
    "Files": [],
    "Errors": [
    "Unable to generate print form"
    ]
    }

См. также

Инструкции:

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

  • DetectCustomPrintForms — определяет нестандартную печатную форму для документов из указанного списка
  • GenerateDocumentProtocol — генерирует печатную форму протокола передачи документа и подпись к ней
  • GenerateDocumentZip — формирует ZIP-архив, содержащий файлы документооборота указанного документа
  • GeneratePrintForm — генерирует печатную форму документа в формате PDF
  • GeneratePrintFormFromAttachment — возвращает идентификатор, с помощью которого можно получить печатную форму документа в формате PDF по его содержимому
  • GeneratePrintFormPng — запускает генерацию печатной формы документа в формате PNG
  • GeneratePrintFormPngFromAttachment — запускает генерацию печатной формы документа в формате PNG по его содержимому
  • GetGeneratedPrintForm — генерирует печатную форму документа по идентификатору, полученному методом GeneratePrintFormFromAttachment
  • GetGeneratedPrintFormResult — возвращает статус и результат генерации печатной формы

Оцените материал страницы

Нашли ошибку или столкнулись с проблемой?

СКБ Контурс 1988 года