获取单个审批实例详情

GET

/v1.0/workflow/processInstances

**
接口调用量说明**钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，获取单个审批实例详情。

接口功能介绍

调用本接口可以获取审批实例详情数据，根据审批实例ID，获取审批实例详情，包括审批实例标题、发起人的userId、审批人userId、操作记录列表等内容。如下图所示。

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	工作流实例读权限	API Explorer
第三方企业应用	支持	工作流实例读权限	API Explorer
第三方个人应用	暂不支持	暂不支持	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	targetSelectApproverScopeError	自选审批人不在规定范围内	自选审批人不在规定范围内
400	targetSelectApproverMissing	自选审批人缺失	自选审批人缺失
400	invalidParameter	获取单个审批实例详情参数错误	获取单个审批实例详情参数错误
400	processInstanceInvalidParameter	审批实例参数错误	审批实例参数错误
400	processInstanceStartFailed	创建审批实例失败	创建审批实例失败
400	needAuth	没有发起审批的权限	没有发起审批的权限
400	invalidAgentId	无效的微应用ID	无效的微应用ID
400	processGroupGetFailed	获取审批流分组失败	获取审批流分组失败
400	processCodeError	获取审批模板失败或者模板已被删除	获取审批模板失败或者模板已被删除
400	processSetupNoPermission	无操作审批流的权限	无操作审批流的权限
400	processGetFailed	获取审批流失败	获取审批流失败
400	formConverterError	表单数据校验失败，失败控件：%s	表单数据校验失败
400	illegalComponent	表单组件入参错误	表单组件入参错误
400	processInstanceIdError	processInstanceId参数无效	processInstanceId参数无效
400	internalError	%s	系统内部异常
400	processFormDataIsNull	流程表单数据为空	流程表单数据为空
500	systemError	系统异常	系统异常

请求示例

Shell

JavaScript

Java

Swift

curl --location --request GET 'https://api.dingtalk.com/v1.0/workflow/processInstances?processInstanceId=String' \
--header 'x-acs-dingtalk-access-token;'

响应示例

{
  "result": {
    "title": "string",
    "finishTime": "string",
    "originatorUserId": "string",
    "originatorDeptId": "string",
    "originatorDeptName": "string",
    "status": "string",
    "approverUserIds": [
      "string"
    ],
    "ccUserIds": [
      "string"
    ],
    "result": "string",
    "businessId": "string",
    "operationRecords": [
      {
        "userId": "string",
        "date": "string",
        "type": "string",
        "result": "string",
        "remark": "string",
        "attachments": [
          {
            "fileName": "string",
            "fileSize": "string",
            "fileId": "string",
            "fileType": "string"
          }
        ],
        "ccUserIds": [
          "string"
        ]
      }
    ],
    "tasks": [
      {
        "taskId": 0,
        "userId": "string",
        "status": "string",
        "result": "string",
        "createTime": "string",
        "finishTime": "string",
        "mobileUrl": "string",
        "pcUrl": "string",
        "processInstanceId": "string",
        "activityId": "string"
      }
    ],
    "bizAction": "string",
    "bizData": "string",
    "attachedProcessInstanceIds": [
      "string"
    ],
    "mainProcessInstanceId": "string",
    "formComponentValues": [
      {
        "id": "string",
        "name": "string",
        "value": "string",
        "extValue": "string",
        "componentType": "string",
        "bizAlias": "string"
      }
    ],
    "createTime": "string"
  },
  "success": "string"
}

请求参数

Query 参数

processInstanceId

string

可选

审批实例ID。

企业内部应用。

调用发起审批实例接口获取InstanceId参数值。

调用获取审批实例ID列表接口获取list参数值。

第三方企业应用。

调用发起审批实例接口获取InstanceId参数值。

通过推送的审批事件中获取，参考biz_type=22。

示例值:

String

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

返回响应

🟢200成功

application/json

Body

result

object

返回结果。

必需

title

string

审批实例标题。

必需

finishTime

string

结束时间。

必需

originatorUserId

string

必需

发起人的userId。

originatorDeptId

string

必需

发起人的部门，-1表示根部门。

originatorDeptName

string

发起人的部门名称。

必需

status

string

必需

审批状态。 NEW：新创建 RUNNING：审批中 TERMINATED：被终止 COMPLETED：完成 CANCELED：取消

approverUserIds

array[string]

必需

审批人userId。说明使用接口发起的审批单返回该参数。在OA审批应用手动发起的审批单不返回该参数。

ccUserIds

array[string]

必需

抄送人userId。

result

string

必需

审批结果。 agree：同意 refuse：拒绝说明 status为COMPLETED且result为agree时，表示审批单完结并审批通过。

businessId

string

审批实例业务编号。

必需

operationRecords

array [object {7}]

操作记录列表。

必需

tasks

array [object {10}]

任务列表。

必需

bizAction

string

必需

审批实例业务动作。 MODIFY：表示该审批实例是基于原来的实例修改而来 REVOKE：表示该审批实例是由原来的实例撤销后重新发起的 NONE：表示正常发起

bizData

string

必需

用户自定义业务参数透出

attachedProcessInstanceIds

array[string]

审批附属实例。

必需

mainProcessInstanceId

string

主流程实例标识。

必需

formComponentValues

array [object {6}]

表单组件详情列表。

必需

createTime

string

创建时间。

必需

success

string

必需

调用是否成功。 true：成功 false：失败

修改于 2024-01-11 08:10:53

发起审批实例

撤销审批实例

获取单个审批实例详情

接口功能介绍#

权限#

错误码#

请求参数

返回响应

接口功能介绍

权限

错误码