Job
本页内容
已有企业签名任务的状态。terminal 表示任务是否结束,只有 status=succeeded 才表示签名成功。
如何阅读本模型
先从下方相关接口确认该模型用于请求还是响应,再按字段层级读取。请求模型由调用方填写,响应模型由平台返回;同名字段在不同模型中可能含义不同。
应用、版本、任务和回执的区别见基本概念。需要一份可跟做的示例时,从相关接口进入对应产品指南。
字段定义
“必需”指字段所在的对象出现时,该字段是否必须存在。类型中含 null 表示值允许为空;未返回、null、空字符串和零分别处理。
| 字段 | 必需 | 说明 |
|---|---|---|
id |
是 | 该条记录的公开标识。调用后续接口时请完整保留,包括前缀。 查看取值约束
|
app_id |
是 | 业务应用的完整 ID,来自列出应用或预留新应用的响应。 查看取值约束
|
status |
是 | 此签名任务的执行状态。结合 terminal 判断是否结束,只有 succeeded 表示成功。 查看取值约束
|
progress |
是 | 签名任务的进度百分比,范围为 0 到 100。 查看取值约束
|
attempt |
是 | 该任务的执行尝试次数。 查看取值约束
|
created_at |
是 | 记录创建时间,Unix 秒。 |
updated_at |
是 | 最近更新时间,Unix 秒。 |
terminal |
是 | 是否进入终态。为 true 时可结束轮询,再用 status 判断结果。 |
error |
是 | 任务失败说明或请求错误对象。为空时没有可用错误详情。 |
error.code |
是 | 机器可读的代码,用于业务判断。 查看取值约束
|
error.message |
是 | 供人阅读的业务说明。程序分支应使用状态或错误码。 |
相关接口
下面根据接口定义列出使用本模型的操作,包括嵌套在其他对象中的情况。接口示例展示完整请求和响应;模型本身不会增加任何权限。