Central do desenvolvedor

Consultar detalhes da tarefa de síntese de ficheiros

GET /esignglobal/v1/templates/renderTask

Descrição da Interface

O ficheiro gerado após preencher o modelo de consulta.

Parâmetros de Pedido

Nome do Parâmetro

Tipo

Obrigatório

Descrição

taskId

string

true

ID da tarefa de composição de ficheiros

Exemplo de Pedido

{
    "taskId": "ccecc62f55a64733a028cb08b406f1b7"
}

Parâmetros de Resposta

Nome do Parâmetro

Tipo

Descrição

taskId

string

ID da tarefa de composição de ficheiros

taskStatus

string

Estado da tarefa de composição de ficheiros

1- A sintetizar

2- Síntese bem-sucedida

3- Falha na síntese

description

string

Explicação do motivo da falha na síntese, devolvido apenas quando taskStatus é 3, não devolvido noutros estados

fileKey

string

ID do ficheiro gerado após a síntese, devolvido apenas quando a síntese é bem-sucedida

downloadUrl

string

Endereço de download do ficheiro sintetizado (válido por 60 minutos), devolvido apenas quando a síntese é bem-sucedida

fieldsarrayInformação do controlo
 fieldIdstringID do controlo
 fieldKeystringCódigo do controlo
 fieldNamestringNome do controlo
 fieldTypeint

Tipo de controlo:

25- Área de assinatura

26- Área de selo

 fieldConfigsobjectDefinições do controlo
  pageNostringPágina onde o controlo se encontra
  posXfloatCoordenada X do controlo
  posYfloatCoordenada Y do controlo
  heightfloatAltura do controlo, unidade: px
  widthfloatLargura do controlo, unidade: px

Exemplo de resposta

{
    "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"
}

 

Descrição da Interface
Parâmetros de Pedido
Exemplo de Pedido
Parâmetros de Resposta
Exemplo de resposta