查询审批流程详情

更新时间:2024-12-06 16:20:40

接口描述

查询本次签署中审批流程的详细信息(仅查询当前appId发起的签署流程产生的审批任务)。

接口地址&请求方法

接口地址:https://{host}/v3/approval/{approvalFlowId}/detail

请求方法:GET

请求头格式

具体请求头参数,请查看公共请求头格式

请求参数

参数名称

参数类型

必选

参数位置

参数说明

approvalFlowId

string

path

审批流程ID(通过【回调通知】或者【查询签署流程详情】接口获取)

补充说明:

需要提前让盖章主体公司对调用方企业应用ID做授权后才可以使用该接口(调用【获取机构认证&授权页面链接】接口,授权添加 org_approval_info manage_org_resource权限范围)。

响应参数

展开全部参数参数名称

参数类型

必选

参数说明(左右拖动查看完整描述)

code

int32

业务码,0表示成功,非0表示异常。

message

string

业务信息

请根据 code 来判断错误情况,不应该依赖 message匹配,因为 message 可能会调整。

data(点击“+”展开详情)

object

业务数据

signFlowId

string

签署流程ID

orgId

string

机构账号ID

orgName

string

机构名称

approvalFlowStatus

int

审批流程状态

1-审批中

2-审批通过

3-审批驳回

4-审批撤回

5-审批终止(超时未审批)

approvalNodes

array

审批节点列表

approvalNodeNum

int

审批节点序号

approvalNodeId

string

审批节点ID

approvalNodeType

int

审批节点类型

1-或审

2-会审

approvalNodeStatus

int

审批节点状态(审批节点下每个审批人都有一个审批任务)

0-未开始

1-待审批

2-已通过

3-已拒绝

approvers

array

审批操作人列表(会审时会存在多个操作人)

approvalOperateTime

long

审批操作时间戳(毫秒级时间戳格式)

psnId

string

审批人账号ID

psnName

string

审批人姓名

请求示例

GET https://openapi.esign.cn/v3/approval/1f21w9****111/detail

响应示例

{
    "code": 0,
    "message": "成功",
    "data": {
        "signFlowId": "961564e1c1111b885acc48d0fd83f",
        "orgId": "842ec8ce3fcb111180675fc91662f",
        "orgName": "测试有限公司",
        "approvalFlowStatus": 2,
        "approvalNodes": [
            {
                "approvalNodeNum": 1,
                "approvalNodeId": "d708cad_1631111251",
                "approvalNodeType": 1,
                "approvalNodeStatus": 2,
                "approvers": [
                    {
                        "psnId": "7ffcaed8c11111118f0ef0a8f6",
                        "psnName": "张三",
                        "approvalOperateTime": 1706781391000
                    }
                ]
            }
        ]
    }
}

错误码

点击查看错误码



我要纠错