Skip to content

查询审批实例操作记录列表

分页查询审批实例操作记录列表

标签审批实例

请求说明

字段
请求地址
https://openapi.wps.cn/v7/workflow/approval_instances/batch_get_timeline
HTTP 方法
GET
接口描述
分页查询审批操作记录
签名方式
KSO-1
限频策略
权限要求
查询审批实例(应用授权) 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,传入该值时查询指定审批定义的操作记录,审批定义id、审批单id、操作的执行人三者至少传一个-
instance_id
string审批单id,传入该值时查询指定审批单的操作记录,审批定义id、审批单id、操作的执行人三者至少传一个-
time_from
string任务查询开始时间,Unix 秒时间戳。与 time_to 参数构成时间段查询条件,仅会返回在该时间段内的审批实例。-
time_to
string任务查询结束时间,Unix 秒时间戳。与 time_from 参数构成时间段查询条件,仅会返回在该时间段内的审批实例。-
operator
string操作的执行人,不传时默认查本租户下的所有数据,审批定义id、审批单id、操作的执行人三者至少传一个-
type
string审批操作类型,不传默认查所有的。查多个时可用,隔开。可选值有:approval_created:发起审批, passed:审批同意, reject:审批拒绝, returned:审批退回, revoke:审批撤回, comment:审批评论, cc:审批抄送, create_group:创建群聊, add_sign:加签, deleted:删除审批实例, rollback:回滚审批实例, auto_passed:自动通过, transfer:转交, auto_approval:自动审批-

响应体(Response)

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

没有可用的数据

响应体示例

json
{
  "data": {
    "has_more": true,
    "page_token": "string",
    "timeline_list": [
      {
        "instance": {
          "approval_define_id": "string",
          "id": "string",
          "serial_no": "string",
          "start_time": 0,
          "status": "auditing",
          "title": "string",
          "user_id": "string"
        },
        "time_line": {
          "comment": "string",
          "comment_attachments": {
            "attachments": [
              {
                "drive_file": {
                  "file_id": "string",
                  "share_link": "string"
                },
                "file_name": "string",
                "file_size": 0,
                "s3_file": {
                  "file_md5": "string",
                  "link": "string",
                  "s3_file_type": "image_file",
                  "store_key": "string",
                  "thumb_store_key": "string"
                },
                "store_type": "drive_file"
              }
            ],
            "images": [
              {}
            ],
            "signature": {}
          },
          "ctime": 0,
          "id": 0,
          "node_id": 0,
          "node_name": "string",
          "operator": "string",
          "type": "approval_created",
          "user_list": [
            "string"
          ]
        }
      }
    ]
  },
  "code": 0,
  "msg": "string"
}