接口描述
查询某个企业下或某企业经办人下的的全部审批流程列表信息(仅查询当前appId发起的签署流程产生的审批流程列表)。
接口地址&请求方法
接口地址:https://{host}/v3/approval/approval-task-list
请求方法:POST
请求头格式
具体请求头参数,请查看公共请求头格式。
请求参数
参数名称 | 参数类型 | 必选 | 参数位置 | 参数说明 |
pageNum | int | 是 | body | 页码(大于0,最小值为1) |
pageSize | int | 是 | body | 每页展示的数量(可选范围[1~100]) |
orgId | string | 是 | body | 机构账号ID(机构账号ID可通过【查询机构认证信息】接口通过组织机构名称/组织机构证件号进行查询) 补充说明: 需要让当前机构提前对调用方企业应用ID做授权后才可以使用该接口(调用【获取机构认证&授权页面链接】接口,授权添加 org_approval_info 或 manage_org_resource权限范围)。 |
operatorPsnId | string | 否 | body | 审批操作人个人账号ID |
queryType | int | 否 | body | 查询方式(必须传入operatorPsnId,才能使用该字段) 1-我参与的(只要操作人是审批流程的参与方就可以查询到) 2-待我审批(必须是审批流程流转到当前操作人审批才能查询到) |
响应参数
展开全部参数参数名称 | 参数类型 | 必选 | 参数说明(左右拖动查看完整描述) | ||||
code | int32 | 是 | 业务码,0表示成功,非0表示异常。 | ||||
message | string | 否 | 业务信息 请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。 | ||||
data(点击“+”展开详情) | object | 否 | 业务数据 | ||||
total | int32 | 否 | 查询结果总数量 | ||||
approvalFlowList(点击“+”展开详情) | array | 否 | 审批任务列表信息 | ||||
signFlowId | string | 否 | 签署流程ID | ||||
approvalFlowId | string | 否 | 审批流程ID | ||||
approvalFlowStatus | int | 否 | 审批流程状态 1-审批中 2-审批通过 3-审批驳回 4-审批撤回 5-审批终止(超时未审批) | ||||
approvalFlowCreateTime | long | 否 | 审批流程创建时间(毫秒级时间戳格式) | ||||
approvalFlowUpdateTime | long | 否 | 审批流程更新时间(毫秒级时间戳格式) |
请求示例
{
"pageNum": 1,
"pageSize": 20,
"orgId": "a14527******922b12709",
"operatorPsnId": "fef71b********2af37",
"queryType": 2
}
响应示例
{
"code": 0,
"message": "成功",
"data": {
"total": 2,
"approvalFlowList": [
{
"signFlowId": "d8cdac8c11111ad6cc4efcb37041b",
"approvalFlowId": "AF-2cb111e01e080e9b",
"approvalFlowStatus": 1,
"approvalFlowCreateTime": 1706777968000,
"approvalFlowUpdateTime": 1706778062000
},
{
"signFlowId": "9cc4c9e23fc1111149dcfb4b653c",
"approvalFlowId": "AF-2b7711115080631",
"approvalFlowStatus": 1,
"approvalFlowCreateTime": 1701421937000,
"approvalFlowUpdateTime": 1701421937000
}
]
}
}