Загрузка результатов задачи на генерацию

Запрос: GET /documents/generate/{typeName}/tasks/{taskId}
HTTP-заголовки:
Authorization: Bearer access_token
Accept: application/json

где {typeName} - наименование типа XML-документа, а {taskId} - идентификатор поставленной задачи.

Описание запроса

Запрос позволяет загрузить результаты выполнения задачи на генерацию по заданному идентификатору. Внешняя система должна периодически запрашивать результаты генерации XML-документа по идентификатору поставленной задачи.

Ответ на запрос

В случае успешного выполнения в ответ возвращается JSON вида:

{
    "TaskStatus": 0,                            // статус обработки задачи
    "TaskHandlingErrorMessage": "string",       // сообщение об ошибке, если задача обработана с ошибкой
    "Results": [                                // результаты выполнения задачи, т. е. XML-документы
        {
            "Content": "base64",                // данные XML-документа в виде массива байт в Base64
            "EncodingName": "string"            // наименование кодировки XML-документа
            "FileName": "string"                // имя файла XML-документа
        }
    ]
}

Возможные значения статуса обработки:

  • 0 - задача запланирована к обработке;

  • 1 - задача успешно обработана;

  • 2 - задача обработана с ошибкой.

Сразу после постановки задача может оказаться в статусе 0. Любое другое значение статуса внешняя система должна воспринимать как завершение обработки задачи и прекращать ожидание.

Поле TaskHandlingErrorMessage заполняется только в случае, если задача была обработана с ошибкой. Поле TaskStatus при этом равно 2.

XML-документ возвращается в коллекции Results. Коллекция заполняется только в случае, если задача была успешно обработана. Поле TaskStatus при этом равно 1.