Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

查询审批定义详情

查询审批定义详情

请求说明

请求地址https://openapi.wps.cn/v7/workflow/approval_instances/{id}
请求方法GET
签名方式KSO-1
权限要求查询审批实例(应用授权) kso.workflow_approval_instance.read
操作审批实例(应用授权) kso.workflow_approval_instance.readwrite
查询审批实例(应用授权) kso.workflow_approval_instance.read
操作审批实例(应用授权) kso.workflow_approval_instance.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

路径参数(Path)

名称类型是否必填说明
idstring<= 1024 characters,审批实例id

查询参数(Query)

名称类型是否必填说明
user_idstring<= 1024 characters,用户id,用来查询该用户的任务

请求地址示例

[GET] https://openapi.wps.cn/v7/workflow/approval_instances/ks-asdassdasdasd342?user_id=kasjdask

响应体(Response)

名称类型说明
codeintegercode
moreobject更多的错误信息
msgstringmsg
dataobject信息返回
approval_define_idstring审批定义id
approval_tasksobject[]审批定义id
approval_rulestring审批方式
end_timestring完成时间
idstring任务id
node_idstring所属节点id
start_timestring开始时间
statusstring任务状态
titlestring所属节点名称
user_idstring审批人用户id
contentsobject[]审批实例内容
attachmentsobject[]如果控件是附件时,附件内容
drive_fileobjectstore_type为drive_file时必填
file_idstring云文档的file_id
share_linkstring文件分享链接
file_namestring文件名
file_sizeint64文件大小
s3_fileobject云文档文件数据, store_type为s3_file时必填
file_md5string文件md5
linkstring静态文件link, 预留字段
s3_file_typestrings3文件类型
store_keystring文件store_key
thumb_store_keystring图片文件缩略图的store_key, 当s3_file_type为image时必传
store_typestring存储类型
idstring控件id, 需要和审批定义保持一致
titlestring控件标题
typestring控件类型
valuestring控件值, 视控件类型而定
valuesstring[]控件内容, 多选专用
current_task_idstring当前任务,当查询有传入user_id且有任务时会返回
end_timestring完成时间
idstring审批实例id
serial_nostring审批单编号
start_timestring开始时间
statusstring审批实例状态
titlestring审批实例标题
user_idstring发起者userid

响应体示例

json
{
  "data": {
    "approval_define_id": "string",
    "approval_tasks": [
      {
        "approval_rule": {},
        "end_time": "string",
        "id": "string",
        "node_id": "string",
        "start_time": "string",
        "status": {},
        "title": "string",
        "user_id": "string"
      }
    ],
    "contents": [
      {
        "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": {},
              "store_key": "string",
              "thumb_store_key": "string"
            },
            "store_type": {}
          }
        ],
        "id": "string",
        "title": "string",
        "type": {},
        "value": "string",
        "values": [
          "string"
        ]
      }
    ],
    "current_task_id": "string",
    "end_time": "string",
    "id": "string",
    "serial_no": "string",
    "start_time": "string",
    "status": {},
    "title": "string",
    "user_id": "string"
  },
  "code": 0,
  "more": {},
  "msg": "string"
}
回到旧版