Skip to content

查询审批实例简要信息列表

分页查询审批实例简要信息列表

标签审批实例

请求说明

字段
请求地址
https://openapi.wps.cn/v7/workflow/approval_instances/batch_get
HTTP 方法
GET
接口描述
分页查询审批实例列表
签名方式
KSO-1
限频策略
权限要求
查询审批实例(应用授权) kso.workflow_approval_instance.read
操作审批实例(应用授权) kso.workflow_approval_instance.readwrite
查询审批实例(用户授权) kso.workflow_approval_instance.read
操作审批实例(用户授权) kso.workflow_approval_instance.readwrite

请求头 (Headers)

属性名类型是否必填描述可选值
X-Kso-Id-Type
string类型
* internal - 内部
* external - 外部
internal, external

查询参数 (Query)

属性名类型是否必填描述可选值
page_size
integer分页大小,取值范围10-50,默认为10-
page_token
string分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果-
approval_define_id
string审批定义id,传入该值时查询指定审批定义的审批实例-
instance_status
string审批实例状态,不传查所有状态。状态有:auditing:审批中, approved:已审批, refused:已拒绝, returned:已退回, revoked:已撤回, terminated:已终止auditing, approved, refused, returned, revoked, deleted, terminated
time_from
string实例查询开始时间,Unix 秒时间戳。与 time_to 参数构成时间段查询条件,仅会返回在该时间段内的审批实例-
time_to
string实例查询结束时间,Unix 秒时间戳。与 time_from 参数构成时间段查询条件,仅会返回在该时间段内的审批实例-
promoter
string实例的发起人,不传时默认查本租户下的所有数据。用户授权时传入该参数会取值为授权的用户id-

响应体(Response)

HTTP状态码: 200
响应体格式: application/json

没有可用的数据

响应体示例

json
{
  "data": {
    "has_more": true,
    "instance_list": [
      {
        "approval_define_id": "string",
        "id": "string",
        "serial_no": "string",
        "start_time": 0,
        "status": "auditing",
        "title": "string",
        "user_id": "string"
      }
    ],
    "page_token": "string"
  },
  "code": 0,
  "msg": "string"
}