查询审批定义详情

查询审批定义详情

请求说明

请求地址	https://openapi.wps.cn/v7/workflow/approval_defines/{id}
请求方法	GET
签名方式	KSO-1
权限要求	操作审批定义（应用授权） kso.workflow_approval_define.readwrite 查询审批定义（应用授权）kso.workflow_approval_define.read 操作审批定义（用户授权） kso.workflow_approval_define.readwrite 查询审批定义（用户授权）kso.workflow_approval_define.read

请求头（Header）

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

路径参数（Path）

名称	类型	是否必填	说明
id	string	是	<= 1024 characters,审批定义id

请求地址示例

[GET] https://openapi.wps.cn/v7/workflow/approval_defines/ks-asdassdasdasd342

响应体（Response）

名称	类型	说明
code	integer	code
more	object	更多的错误信息
msg	string	msg
data	object	信息返回
∟ created_by	object	创建者
∟ ∟ avatar	string	用户或应用的头像
∟ ∟ company_id	string	身份所归属的公司
∟ ∟ id	string	身份ID
∟ ∟ name	string	用户或应用的名称
∟ ∟ type	object	身份类型
∟ ctime	string	创建时间，时间戳（ms）
∟ form_designs	object[]	审批表单定义
∟ ∟ form_options	object[]	控件为多选时，选项内容
∟ ∟ ∟ key	string	选项key
∟ ∟ ∟ value	string	选项值
∟ ∟ id	string	表单控件id，需要业务方自行指定，id不可重复
∟ ∟ placeholder	string	控件默认填充内容
∟ ∟ required	boolean	控件内容是否必填，不传默认false
∟ ∟ title	string	控件标题
∟ ∟ type	string	控件类型
∟ icon	string	审批定义图标
∟ id	string	审批定义id
∟ name	string	审批定义名称
∟ process_define	object	审批流程定义
∟ ∟ nodes	object[]	节点列表
∟ ∟ ∟ child_nodes	string	子节点
∟ ∟ ∟ condition_groups	object[]	条件组
∟ ∟ ∟ ∟ conditions	object[]	条件
∟ ∟ ∟ ∟ ∟ custom_data_rule	string	用于用户自定义表单
∟ ∟ ∟ ∟ ∟ form_id	string	表单控件id，需要和审批定义里对应
∟ ∟ ∟ ∟ ∟ rule	string	条件规则
∟ ∟ ∟ ∟ ∟ type	string	控件类型
∟ ∟ ∟ ∟ ∟ value	string	条件值，不同的条件类型对应不同的结构体
∟ ∟ ∟ id	string	节点编号,同一树下需要唯一
∟ ∟ ∟ name	string	节点名称
∟ ∟ ∟ next_node_id	string	下一个节点
∟ ∟ ∟ task	object	任务
∟ ∟ ∟ ∟ task_approve	object	审批任务
∟ ∟ ∟ ∟ ∟ approval_rule	string	审批规则，只有当审批/抄送用户是多人时赋值
∟ ∟ ∟ ∟ ∟ select_type	string	选择方式，只有当用户类型是发起人自选时赋值
∟ ∟ ∟ ∟ ∟ target	object	审批人员
∟ ∟ ∟ ∟ ∟ ∟ level	int	多级负责人层级,最多9级
∟ ∟ ∟ ∟ ∟ ∟ user_group_ids	string[]	用户组
∟ ∟ ∟ ∟ ∟ ∟ user_ids	string[]	用户id,当type为指定成员时需要传入
∟ ∟ ∟ ∟ ∟ ∟ user_type	string	用户类型
∟ ∟ ∟ ∟ task_cc	object	抄送任务
∟ ∟ ∟ ∟ ∟ target	object	抄送目标
∟ ∟ ∟ ∟ ∟ ∟ level	int	多级负责人层级,最多9级
∟ ∟ ∟ ∟ ∟ ∟ user_group_ids	string[]	用户组
∟ ∟ ∟ ∟ ∟ ∟ user_ids	string[]	用户id,当type为指定成员时需要传入
∟ ∟ ∟ ∟ ∟ ∟ user_type	string	用户类型
∟ ∟ ∟ ∟ type	string	任务类型
∟ ∟ root	string	根节点序号
∟ visible_scopes	object[]	审批定义可见范围
∟ ∟ company_id	string	可见范围所属公司id
∟ ∟ is_admin	boolean	是否为管理员,当scope_type为user时有效,默认false
∟ ∟ scope_id	string	可见范围id，公司id/部门id/用户id
∟ ∟ scope_type	string	可见范围类型

响应体示例

{
  "data": {
    "created_by": {
      "avatar": "string",
      "company_id": "string",
      "id": "string",
      "name": "string",
      "type": {}
    },
    "ctime": "string",
    "form_designs": [
      {
        "form_options": [
          {
            "key": "string",
            "value": "string"
          }
        ],
        "id": "string",
        "placeholder": "string",
        "required": true,
        "title": "string",
        "type": {}
      }
    ],
    "icon": {},
    "id": "string",
    "name": "string",
    "process_define": {
      "nodes": [
        {
          "child_nodes": [
            "string"
          ],
          "condition_groups": [
            {
              "conditions": [
                {
                  "custom_data_rule": "string",
                  "form_id": "string",
                  "rule": {},
                  "type": {},
                  "value": "string"
                }
              ]
            }
          ],
          "id": "string",
          "name": "string",
          "next_node_id": "string",
          "task": {
            "task_approve": {
              "approval_rule": {},
              "select_type": {},
              "target": {
                "level": 0,
                "user_group_ids": [
                  "string"
                ],
                "user_ids": [
                  "string"
                ],
                "user_type": {}
              }
            },
            "task_cc": {
              "target": {
                "level": 0,
                "user_group_ids": [
                  "string"
                ],
                "user_ids": [
                  "string"
                ],
                "user_type": {}
              }
            },
            "type": {}
          },
          "type": {}
        }
      ],
      "root": "string"
    },
    "visible_scopes": [
      {
        "company_id": "string",
        "is_admin": true,
        "scope_id": "string",
        "scope_type": {}
      }
    ]
  },
  "code": 0,
  "more": {},
  "msg": "string"
}