Центр разработчиков

Запрос подробностей о задаче синтеза файлов

GET /esignglobal/v1/templates/renderTask

Описание интерфейса

Файл, сгенерированный после заполнения шаблона запроса.

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

Название параметра

Тип

Обязательно

Описание

taskId

string

true

Идентификатор задачи синтеза файла

Пример запроса

{
    "taskId": "ccecc62f55a64733a028cb08b406f1b7"
}

Параметры ответа

Название параметра

Тип

Описание

taskId

string

Идентификатор задачи синтеза файла

taskStatus

string

Статус синтеза файла

1-В процессе синтеза

2-Синтез выполнен успешно

3-Синтез не удался

description

string

Описание причины сбоя синтеза, возвращается только когда taskStatus равен 3, в других состояниях не возвращается

fileKey

string

ID файла, сгенерированного после синтеза, возвращается только при успешном синтезе

downloadUrl

string

URL-адрес для скачивания файла после синтеза (действителен в течение 60 минут), возвращается только при успешном синтезе

fieldsarrayИнформация об элементе управления
 fieldIdstringID элемента управления
 fieldKeystringКод элемента управления
 fieldNamestringНазвание элемента управления
 fieldTypeint

Тип элемента управления:

25-Область подписи

26-Область печати

 fieldConfigsobjectНастройки элемента управления
  pageNostringНомер страницы, на которой находится элемент управления
  posXfloatКоордината X элемента управления
  posYfloatКоордината Y элемента управления
  heightfloatВысота элемента управления, единица измерения: px
  widthfloatШирина элемента управления, единица измерения: px

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

{
    "code": "0",
    "data": {
        "downloadUrl": "https://global-dev.s3.cn-northwest-1.amazonaws.com.cn/epaas-docedit/9c4aa968-92a3-4346-8a33-528e584f79d4/pdf%20%E5%9B%BE%E7%89%87%E8%B5%84%E6%BA%90%E6%89%BE%E4%B8%8D%E5%88%B0bug%E9%AA%8C%E8%AF%81.pdf?response-content-disposition=attachment&X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIASKKKTSYU5RW7YI4L%2F20240830%2Fcn-northwest-1%2Fs3%2Faws4_request&X-Amz-Date=20240830T091607Z&X-Amz-Expires=1800&X-Amz-SignedHeaders=host&X-Amz-Signature=c7bc64eacd705af6144e3aafe7c4507ac79518d25cc95e7654c87e89b836047f",
        "fileKey": "$9cd40d42-b472-479c-bf3c-93ed8efc2863$3429580140",
        "taskId": "ccecc62f55a64733a028cb08b406f1b7",
        "taskStatus": "2"
    },
    "message": "success"
}

 

Описание интерфейса
Параметры запроса
Пример запроса
Параметры ответа
Пример ответа