首页 > API文档 > CRM
审批流程接口
更新时间: 2021-12-08 11:46:14

审批流程接口

1.查询CRM对象实例关联的审批实例

请求路径: https://open.71360.com/cgi/crm/object/approvalInstances/query

请求方式:post + application/json 方式

参数说明:
参数参数类型必须说明
corpAccessTokenString企业应用访问公司合法性凭证
corpIdString开放平台公司账号
currentOpenUserIdString当前操作人的openUserId
dataIdStringCRM数据Id
请求包结构体示例:
{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "currentOpenUserId": "FSUID_xxxxx",
    "dataId":"c5121734b3904060af0f29bc8c9c3342"
}
返回说明:
参数必须说明
errorCode返回码
errorMessage对返回码的文本描述内容
instances流程实例列表(instance数组)
instances.instanceId流程实例id
instances.instanceName流程实例名称
instances.dataId流程实例关联的数据id
instances.triggerType操作类型 Create新建,Update编辑,Invalid作废,Delete删除
instances.state流程实例状态 in_progress 进行中,pass 通过,error 异常,cancel 取消,reject 拒绝
instances.createTime流程实例创建时间
instances.lastModifyTime流程实例最后更新时间
instances.endTime流程实例结束时间
instances.flowApiName审批流程 apiName
instances.applicantOpenUserId流程实例发起人
instances.cancelTime流程实例的取消时间
instances.objectApiName数据对象的 apiName
正确JSON 返回示例:
{
    "errorCode": 0, 
    "errorMessage": "success", 
    "instances": [
        {
            "instanceId": "5938ef093db71d57841afaa8", 
            "instanceName": "CreateTradeCode-02548-201706082017-06-08 02:30", 
            "dataId": "9e9aeda937a843cf8b0668f17d939fdf", 
            "triggerType": "Create", 
            "state": "pass", 
            "createTime": 1496903433459, 
            "lastModifyTime": 1496903455210, 
            "endTime": 1496903455061, 
            "flowApiName": "apprDLWEK4A83N__crmapp", 
            "applicantOpenUserId": "FSUID_55E332B8B9637C744CFD5FC89F7FCA57", 
            "cancelTime": 0, 
            "objectApiName": "SalesOrderObj"
        }
    ]
}
错误JSON 返回示例:
{
    "errorCode": 20016,
    "errorMessage": "corpAccessToken error"
}

2.根据审批实例ID获取审批详情

请求路径: https://open.71360.com/cgi/crm/approvalInstance/get

请求方式:post + application/json 方式

参数说明:
参数类型必须备注
corpAccessTokenString企业应用访问公司合法性凭证
corpIdString开放平台公司账号
currentOpenUserIdString当前操作人的openUserId
instanceIdString流程实例Id
请求包结构体示例:
{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "currentOpenUserId": "FSUID_xxxxx",
    "instanceId":"595d9e363db71d791fe0a21c"
}
返回说明:
参数必须说明
errorCode返回码
errorMessage对返回码的文本描述内容
instanceDetail流程实例详情
instanceDetail.instance流程实例详情
instanceDetail.tasks流程实例详情
instanceDetail.tasks.id任务id
instanceDetail.tasks.type

任务类型 单人审批single 多人审批one_pass 会签all_pass

单人审批single:一个人过就过

多人审批one_pass:多个人当中一个人通过就过

会签 ll_pass:所有人都通过才过

instanceDetail.tasks.state任务状态 进行中 in_progress ;通过 pass;自动通过 auto_pass;拒绝 reject;取消 cancel;回退 go_back;自动回退 auto_go_back;定时 schedule;异常 error
instanceDetail.tasks.flowApiName审批流 apiName
instanceDetail.tasks.createTime创建时间
instanceDetail.tasks.modifyTime最后更新时间
instanceDetail.tasks.opinions审批意见
instanceDetail.tasks.unCompletePersons未完成人员列表
instanceDetail.tasks.endTime完成时间
instanceDetail.tasks.completeOpenPersons已完成人员列表
正确JSON 返回示例:
{
    "errorCode": 0, 
    "errorMessage": "success", 
    "instanceDetail": {
        "instance": {
            "instanceId": "595d9e363db71d791fe0a21c", 
            "instanceName": "CreateTradeCode-02840-201707062017-07-06 10:19", 
            "dataId": "e1416ec0abc442088f856fba72db190d", 
            "triggerType": "Create", 
            "state": "pass", 
            "createTime": 1499307574025, 
            "lastModifyTime": 1499742733395, 
            "endTime": 1499742733144, 
            "flowApiName": "apprC0YRSCYXVG__crmappr", 
            "applicantOpenUserId": "FSUID_55E332B8B9637C744CFD5FC89F7FCA57", 
            "cancelTime": 0, 
            "objectApiName": "SalesOrderObj"
        }, 
        "tasks": [
            {
                "id": "595d9e363db71d791fe0a21d", 
                "type": "single", 
                "state": "pass", 
                "flowApiName": "apprC0YRSCYXVG__crmappr", 
                "createTime": 1499307574027, 
                "modifyTime": 1499742733113, 
                "opinions": [
                    {
                        "actionType": "agree", 
                        "opinion": "tongyi", 
                        "replyTime": 1499742733105, 
                        "openUserId": "FSUID_55E332B8B9637C744CFD5FC89F7FCA57"
                    }
                ], 
                "unCompletePersons": [ ], 
                "endTime": 1499742733113, 
                "completeOpenPersons": [
                    "FSUID_55E332B8B9637C744CFD5FC89F7FCA57"
                ]
            }
        ]
    }
}
错误JSON 返回示例:
{
    "errorCode": 20016,
    "errorMessage": "corpAccessToken error"
}

3.根据审批任务ID执行审批操作:同意、驳回

请求路径:https://open.71360.com/cgi/crm/approvalTask/action

请求方式:post + application/json 方式

参数说明:
参数类型必须备注
corpAccessTokenString企业应用访问公司合法性凭证
corpIdString开放平台公司账号
currentOpenUserIdString当前操作人的openUserId ;(必须为当前task的执行人)
taskIdString任务实例Id
actionTypeString操作类型 同意:agree ;拒绝:reject
opinionString意见内容
请求包结构体示例:
{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "currentOpenUserId": "FSUID_xxxxx",
    "taskId":"taskId",
    "actionType":"agree",
    "opinion":"tongyi"
}
返回说明:
参数必须说明
errorCode返回码
errorMessage对返回码的文本描述内容
正确JSON 返回示例(销售订单样例):
{
    "errorCode": 0, 
    "errorMessage": "success"
}
错误JSON 返回示例:
{
    "errorCode": 20016,
    "errorMessage": "corpAccessToken error"
}

4.查询指定审批规则的审批实例列表

请求路径:https://open.71360.com/cgi/crm/approvalInstances/query

请求方式:post + application/json 方式

参数说明:
参数类型必须备注
corpAccessTokenString企业应用访问公司合法性凭证
corpIdString开放平台公司账号
currentOpenUserIdString当前操作人的openUserId
flowApiNameString审批流程 apiName
stateString流程状态 流程实例状态 in_progress 进行中,pass 通过,error 异常,cancel 取消,reject 拒绝
startTimeString开始时间(时间戳形式)
endTimeString结束时间(时间戳形式)
objectApiNameString数据对象apiName
pageNumberint页码默认为 1
pageSizeint分页大小默认 20
请求包结构体示例:
{
    "corpAccessToken": "CORP_ACCESS_TOKEN",
    "corpId": "CORP_ID",
    "currentOpenUserId": "FSUID_xxxxx",
    "flowApiName": "apprDLWEK4A83N__crmapp",
    "state":"in_progress",
    "startTime" : 1473339930303,
    "endTime" : 1498798899999,
    "pageNumber" : 1,
    "pageSize" : 50
}
返回说明:
参数必须说明
errorCode返回码
errorMessage对返回码的文本描述内容
queryResult查询返回结果数据
queryResult.total总记录数
queryResult.instanceList流程实例列表
正确JSON 返回示例(销售订单样例):
{
    "errorCode": 0, 
    "errorMessage": "success", 
    "queryResult": {
        "total": 50, 
        "instanceList": [
            {
                "instanceId": "5938ef093db71d57841afaa8", 
                "instanceName": "CreateTradeCode-02548-201706082017-06-08 02:30", 
                "dataId": "9e9aeda937a843cf8b0668f17d939fdf", 
                "triggerType": "Create", 
                "state": "pass", 
                "createTime": 1496903433459, 
                "lastModifyTime": 1496903455210, 
                "endTime": 1496903455061, 
                "flowApiName": "apprDLWEK4A83N__crmapp", 
                "applicantOpenUserId": "FSUID_55E332B8B9637C744CFD5FC89F7FCA57", 
                "cancelTime": 0, 
                "objectApiName": "SalesOrderObj"
            }, 
            {
                "instanceId": "5938ef093db71d57832432ff", 
                "instanceName": "CreateTradeCode-02432-201706082017-06-08 02:30", 
                "dataId": "9e9aeda937a843cf8b066878688987", 
                "triggerType": "Create", 
                "state": "pass", 
                "createTime": 1496903433459, 
                "lastModifyTime": 1496903455210, 
                "endTime": 1496903455061, 
                "flowApiName": "apprDLWEK4A83N__crmapp", 
                "applicantOpenUserId": "FSUID_55E332B8B9637C744CFD5FC89F7FCA57", 
                "cancelTime": 0, 
                "objectApiName": "SalesOrderObj"
            }
        ]
    }
}
错误JSON 返回示例:
{
    "errorCode": 20016,
    "errorMessage": "corpAccessToken error"
}