获取审批实例ID列表

POST

/v1.0/workflow/processes/instanceIds/query

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

调用本接口，获取权限范围内的相关部门审批实例ID列表。

接口调用流程

可以调用本接口获取审批流对应的审批实例ID。

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

接口调用说明

如果只传入startTime参数，要求时间距离当前时间不能超过120天，endTime不传则默认取当前时间。

如果传入startTime参数和endTime参数，要求时间范围不能超过120天，同时startTime时间距当前时间不能超过365天。

批量获取的实例ID个数（循环获取），最多不能超过10000个。

权限

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

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

错误码

HttpCode	错误码	错误信息	说明
400	invalidProcessCode	审批模版processCode不能为空	审批模版processCode不能为空
400	invalidInstanceListIdsStartTime	获取审批实例ID列表，审批实例开始时间不能为空	获取审批实例ID列表，审批实例开始时间不能为空
400	invalidNextToken	获取审批实例ID列表，分页查询的游标不能为空	获取审批实例ID列表，分页查询的游标不能为空
400	invalidMaxResults	获取审批实例ID列表，分页参数非法，每页大小，最多传20。	获取审批实例ID列表，分页参数非法，每页大小，最多传20。
400	invalidEndTime	获取审批实例ID列表，审批实例结束时间不能小于开始时间；且查询时间范围不能超过120天。	获取审批实例ID列表，审批实例结束时间不能小于开始时间；且查询时间范围不能超过120天。
400	invalidUserIds	获取审批实例ID列表，发起userid列表参数非法，最大列表长度为10。	获取审批实例ID列表，发起userid列表参数非法，最大列表长度为10。
400	internalError	%s	系统内部异常
500	systemError	系统异常	系统异常

请求参数

Header 参数

Body 参数application/json

示例


{
  "processCode" : "String",
  "startTime" : Long,
  "endTime" : Long,
  "nextToken" : Long,
  "maxResults" : Long,
  "userIds" : [ "String" ],
  "statuses" : [ "String" ]
}

请求示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/v1.0/workflow/processes/instanceIds/query' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "processCode" : "String",
  "startTime" : Long,
  "endTime" : Long,
  "nextToken" : Long,
  "maxResults" : Long,
  "userIds" : [ "String" ],
  "statuses" : [ "String" ]
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "result": {
        "list": [
            "string"
        ],
        "nextToken": "string"
    },
    "success": true
}

修改于 2025-09-08 06:28:05

添加审批评论

获取审批钉盘空间信息

获取审批实例ID列表

接口调用流程#

接口调用说明#

权限#

错误码#

请求参数

请求示例代码

返回响应

接口调用流程

接口调用说明

权限

错误码