開発者センター

ファイル合成タスクの詳細を照会

GET /esignglobal/v1/templates/renderTask

インターフェースの説明

クエリテンプレート入力後に生成されるファイル。

リクエストパラメータ

パラメータ名

タイプ

必須

説明

taskId

string

true

ファイル合成タスクID

リクエスト例

{
    "taskId": "ccecc62f55a64733a028cb08b406f1b7"
}

レスポンスパラメータ

パラメータ名

タイプ

説明

taskId

string

ファイル合成タスクID

taskStatus

string

ファイル合成ステータス

1-合成中

2-合成成功

3-合成失敗

description

string

合成失敗の原因説明。taskStatusが3の場合のみ返され、他の状態では返されません。

fileKey

string

合成後に生成されたファイルID。合成が成功した場合のみ返されます。

downloadUrl

string

合成後のファイルのダウンロードアドレス(有効期間60分)。合成が成功した場合のみ返されます。

fieldsarrayコントロール情報
 fieldIdstringコントロールID
 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"
}

 

インターフェースの説明
リクエストパラメータ
リクエスト例
レスポンスパラメータ
レスポンス例