跳转到主要内容
1签 (OneSign)

Job

本页内容

已有企业签名任务的状态。terminal 表示任务是否结束,只有 status=succeeded 才表示签名成功。

如何阅读本模型

先从下方相关接口确认该模型用于请求还是响应,再按字段层级读取。请求模型由调用方填写,响应模型由平台返回;同名字段在不同模型中可能含义不同。

应用、版本、任务和回执的区别见基本概念。需要一份可跟做的示例时,从相关接口进入对应产品指南。

字段定义

“必需”指字段所在的对象出现时,该字段是否必须存在。类型中含 null 表示值允许为空;未返回、null、空字符串和零分别处理。

字段必需说明
id 是

该条记录的公开标识。调用后续接口时请完整保留,包括前缀。

类型:string

查看取值约束
  • 格式 ^J[a-f0-9]{32}$
app_id 是

业务应用的完整 ID,来自列出应用或预留新应用的响应。

类型:string

查看取值约束
  • 格式 ^A[a-f0-9]{32}$
status 是

此签名任务的执行状态。结合 terminal 判断是否结束,只有 succeeded 表示成功。

类型:string

查看取值约束
  • 可选值 preparing / ready / leased / running / verifying / publishing / succeeded / failed / cancelled / superseded / unknown
  • preparing — 准备任务
  • ready — 等待分配执行
  • leased — 节点已领取
  • running — 正在签名
  • verifying — 校验签名结果
  • publishing — 发布签名产物
  • succeeded — 执行成功
  • failed — 执行失败
  • cancelled — 已取消
  • superseded — 已被后续任务替代
  • unknown — 暂无法识别状态
progress 是

签名任务的进度百分比,范围为 0 到 100。

类型:integer

查看取值约束
  • 最小值 0
  • 最大值 100
attempt 是

该任务的执行尝试次数。

类型:integer

查看取值约束
  • 最小值 0
created_at 是

记录创建时间,Unix 秒。

类型:integer

updated_at 是

最近更新时间,Unix 秒。

类型:integer

terminal 是

是否进入终态。为 true 时可结束轮询,再用 status 判断结果。

类型:boolean

error 是

任务失败说明或请求错误对象。为空时没有可用错误详情。

类型:null | object

error.code 是

机器可读的代码,用于业务判断。

类型:string

查看取值约束
  • 固定值 SigningFailed
error.message 是

供人阅读的业务说明。程序分支应使用状态或错误码。

类型:string

相关接口

下面根据接口定义列出使用本模型的操作,包括嵌套在其他对象中的情况。接口示例展示完整请求和响应;模型本身不会增加任何权限。

作为成功响应