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

JobResult

本页内容

指定签名任务与其准确产物的关联结果。result_state=available 时读取 signed_version;其他状态不能用版本列表第一项代替。

如何阅读本模型

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

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

字段定义

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

字段必需说明
app_id 是

任务所属的完整应用 ID。

类型:string

查看取值约束

当前账号拥有且获授权的企业签名应用完整 A 标识。

  • 格式 ^A[a-f0-9]{32}$
job_id 是

本次查询的完整签名任务 ID。

类型:string

查看取值约束

本次查询的准确签名任务 J 标识。

  • 格式 ^J[a-f0-9]{32}$
status 是

此签名任务的状态。任务成功后还需检查 result_state 和 signed_version。

类型:string

查看取值约束

任务状态。succeeded 表示发布完成,仍须检查 result_state。

  • 可选值 preparing / ready / leased / running / verifying / publishing / succeeded / failed / cancelled / superseded
  • preparing — 准备任务
  • ready — 等待分配执行
  • leased — 节点已领取
  • running — 正在签名
  • verifying — 校验签名结果
  • publishing — 发布签名产物
  • succeeded — 执行成功
  • failed — 执行失败
  • cancelled — 已取消
  • superseded — 已被后续任务替代
terminal 是

是否为终态:succeeded、failed、cancelled、superseded。

类型:boolean

result_state 是

此任务产物的可用状态。available 时读取 signed_version;其他状态按接口的结果判断说明处理。

类型:string

查看取值约束

pending 正在执行;available 可取准确签名 V;not_produced 任务未成功;not_recorded 旧任务无可信关联;removed 产物版本已清理。

  • 可选值 pending / available / not_produced / not_recorded / removed
source_version 是

本次签名实际使用的原包版本。

类型:object | null

查看取值约束

该 J 实际输入的原包版本。若已清理则为 null,不是签名包。

source_version.id 是

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

类型:string

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

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

类型:string

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

IPA 的 Bundle ID 或 APK 的包名,须与对应安装包一致。

类型:string

source_version.platform 是

安装包平台。ipa 对应 iOS,apk 对应 Android。

类型:string

查看取值约束
  • 可选值 ipa / apk
  • ipa — iOS 安装包
  • apk — Android 安装包
source_version.version 是

安装包对用户展示的版本号。

类型:string

source_version.build 是

安装包的内部构建版本。

类型:string

source_version.size_bytes 是

文件大小,单位为字节。

类型:integer

source_version.package_type 是

original 为原始上传包,signed 为签名后的产物。

类型:string

查看取值约束
  • 可选值 original / signed
  • original — 原始上传包
  • signed — 签名后的安装包
source_version.is_current 是

该类型安装包的当前发布标记;原包与签名包可各自为当前版本

类型:boolean

source_version.created_at 是

Unix 秒;无法解析的旧时间为 0

类型:integer

signed_version 是

明确关联到本次任务的签名产物版本;结果尚不可用时按空值处理。

类型:object | null

查看取值约束

仅 available 时返回准确的签名版本;其他状态为 null。id 用于 DownloadSigned 票据;不要求 is_current=true。

signed_version.id 是

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

类型:string

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

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

类型:string

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

IPA 的 Bundle ID 或 APK 的包名,须与对应安装包一致。

类型:string

signed_version.platform 是

安装包平台。ipa 对应 iOS,apk 对应 Android。

类型:string

查看取值约束
  • 可选值 ipa / apk
  • ipa — iOS 安装包
  • apk — Android 安装包
signed_version.version 是

安装包对用户展示的版本号。

类型:string

signed_version.build 是

安装包的内部构建版本。

类型:string

signed_version.size_bytes 是

文件大小,单位为字节。

类型:integer

signed_version.package_type 是

original 为原始上传包,signed 为签名后的产物。

类型:string

查看取值约束
  • 可选值 original / signed
  • original — 原始上传包
  • signed — 签名后的安装包
signed_version.is_current 是

该类型安装包的当前发布标记;原包与签名包可各自为当前版本

类型:boolean

signed_version.created_at 是

Unix 秒;无法解析的旧时间为 0

类型:integer

published_at 是

可信关联记录中的发布时间(Unix 秒);尚未发布或旧记录缺失时为 null。

类型:integer | null

查看取值约束
  • integer (最小值 1)

相关接口

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

作为成功响应