查询签署区列表
接口地址 /v1/signflows/{flowId}/signfields
请求方式 GET
接口描述 查询流程签署区列表,可以查询指定指定id或者签署人所属的签署区
请求参数
参数名称 | 说明 | 参数类型 | 必填 | 类型 |
---|---|---|---|---|
flowId | 流程id | path | true | string |
accountId | 账号id,默认所有签署人 | query | false | string |
signfieldIds | 指定签署区id列表,逗号分割,默认所有签署区 | query | false | string |
请求示例
GET https://openapi.esign.cn/v1/signflows/429b1d3038854cabbcdac0a63d7e4c0d/signfields?accountId=99b9513fa07c4dc4b1e77aecc2588cb6
响应参数
参数名称 | 说明 | 类型 | ||
---|---|---|---|---|
signfields | 签署区列表数据 | array | ||
actorIndentityType | 签约主体类别,0-个人,1-机构,默认0,2 是不限 | int32 | ||
addTime | 添加时间 | int64 | ||
assignedPosbean | 是否指定位置,TRUE表示不允许更新位置,配置项,无默认值 | boolean | ||
assignedSeal | 是否指定印章数据,TRUE表示不允许更新印章,配置项,无默认值 | boolean | ||
authorizedAccountId | 签约主体账号标识,将使用该主体账号对应的数字证书完成本次签署,如:当存在签署操作人代某机构签署时,需要传入该机构的账号id | string | ||
autoExecute | 是否自动执行,TRUE需要静默授权,配置项,无默认值 | boolean | ||
executeFailedReason | 执行失败原因 | string | ||
fileId | 文件file id | string | ||
flowId | 流程id | string | ||
order | 签署区顺序,默认1,且不小于1,顺序越小越先处理 | int32 | ||
posBean | 签署区位置信息 | 签署区位置数据 | ||
posPage | 页码信息,可以','或'-'分割 | string | ||
posX | x坐标 | float | ||
posY | y坐标 | float | ||
width | 签署区宽 | float | ||
sealFileKey | 印章文件file key | string | ||
sealId | 印章id | string | ||
sealType | 印章类型,支持多种类型时逗号分割,0-手绘印章,1-模版印章,为空不限制 | string | ||
signType | 签署类型,0-不限,1-单页签署,2-骑缝签署,4-关键字签署,默认1 | int32 | ||
signerAccountId | 签署操作人个人账号标识,即操作本次签署的个人,如需e签宝通知用户签署,则系统向该账号下绑定的手机、邮箱发送签署链接 | string | ||
signfieldId | 签署区Id | string | ||
status | 签署区状态(0:"等待执行,1:"执行中",2:"执行失败",3:"审批中",4: "执行完成") | int32 | ||
statusDescription | 状态描述 | string |
响应示例
{
"code": 0,
"message": "成功",
"data": {
"signfields": [
{
"signfieldId": "b76b69d5b48d4f689cae997e42809ac4",
"flowId": "b2cb74258a634179b0df3cc54791c8b6",
"signerAccountId": "faea8237c61a4fdea864ee8d7621e14f",
"authorizedAccountId": "2c7de24aff3340f5b944ebac49545b8e",
"fileId": "fe7df2f477d649c18ebcfdfffeba253d",
"status": 1,
"statusDescription": "执行中",
"executeFailedReason": null,
"addTime": 1561473111450,
"sealType": "",
"signType": 0,
"order": 1,
"autoExecute": false,
"assignedPosbean": false,
"assignedSeal": false,
"addSignTime": false,
"actorIndentityType": 1,
"sealId": "",
"sealFileKey": "",
"posBean": {
"posPage": "1",
"posX": 158.72531,
"posY": 431.05658
}
}
]
}
}
错误码
错误码 | 错误信息 | 错误原因 |
---|---|---|