简体中文
查询审批流实例列表
约 294 字小于 1 分钟
2026-01-16
描述
查询审批流实例列表
请求说明
请求方式:POST + application/json
请求路径:https://${填入所在云的域名}/cgi/crm/approvalInstances/query?thirdTraceId=${随机字符串}
请求头填写 :参考公共参数填写
请求参数
| 参数 | 类型 | 是否必填 | 说明 |
|---|---|---|---|
| includeNull | Boolean | 否 | 是否包含 null 字段,false:不返回,true:返回,不传默认为false |
| flowApiName | String | 是 | 审批流程 apiName |
| state | String | 否 | 流程状态 流程实例状态 in_progress 进行中,pass 通过,error 异常,cancel 取消,reject 拒绝 |
| startTime | String | 是 | 开始时间(时间戳形式) |
| endTime | String | 是 | 结束时间(时间戳形式) |
| objectApiName | String | 否 | 数据对象apiName |
| pageNumber | Int | 否 | 页码默认为 1 |
| pageSize | Int | 否 | 分页大小默认 20 |
请求示例
{
"includeNull": true,
"pageNumber": 1,
"flowApiName": "hello",
"pageSize": 1,
"startTime": "hello",
"objectApiName": "hello",
"state": "hello",
"endTime": "hello"
}返回参数
| 参数 | 类型 | 说明 |
|---|---|---|
| traceId | string | 请求唯一ID |
| errorDescription | string | 错误描述 |
| errorMessage | string | 错误信息 |
| errorCode | Int | 查看错误码 |
返回示例
{
"traceId": "E-O.827xxxxxx",
"errorDescription": "success",
"errorMessage": "OK",
"errorCode": 0
}注意事项
- 不能使用返回值的message字段做逻辑判断,errorMessage会有变化;
