# 模拟审批流程

模拟审批实例流程



**标签**：`审批实例` 


## 请求说明
| 字段          | 值                  |
|--------------|---------------------|
| **<div style="white-space: nowrap;">请求地址</div>**  | https://openapi.wps.cn/v7/workflow/approval_instances/simulation          |
| **<div style="white-space: nowrap;">HTTP 方法</div>** | `POST`    |
| **<div style="white-space: nowrap;">接口描述</div>**  | 模拟审批实例流程 |
| **<div style="white-space: nowrap;">签名方式</div>**  | [KSO-1](https://open.wps.cn/documents/app-integration-dev/wps365/server/api-description/signature-description) |
| **<div style="white-space: nowrap;">限频策略</div>** | 无 |
| **<div style="white-space: nowrap;">权限要求</div>** | <div><div>操作审批实例(应用授权) `kso.workflow_approval_instance.readwrite`</div></div> |


## 请求头 (Headers)
| 属性名 | 类型 | 是否必填 | 描述 | 可选值 |
|-------|------|------|-------|-------|
| <div style="white-space: nowrap;">X-Kso-Id-Type</div> | `string` | 否 | 类型<br>  * **internal** - 内部<br>  * **external** - 外部<br> | `internal`, `external` 







## 请求体(Body)
**请求体格式:** `application/json`
<OpenapiRenderTable  dataSource='[{"key":"approval_define_id","name":"approval_define_id","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>审批定义id</p>\n","children":[]},{"key":"contents","name":"contents","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>审批实例内容</p>\n","children":[{"key":"contents.items.attachments","name":"attachments","deprecated":false,"type":"array[object]","required":"否","enum":[],"xEnum":[],"description":"<p>如果控件是附件时，附件内容</p>\n","children":[{"key":"contents.items.attachments.items.drive_file","name":"drive_file","deprecated":false,"type":"object","required":"是","enum":[],"xEnum":[],"description":"<p>云文档文件数据,store_type为drive_file时必填</p>\n","children":[{"key":"contents.items.attachments.items.drive_file.file_id","name":"file_id","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>云文档的file_id</p>\n","children":[]},{"key":"contents.items.attachments.items.drive_file.share_link","name":"share_link","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>文件分享链接</p>\n","children":[]}]},{"key":"contents.items.attachments.items.file_name","name":"file_name","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>文件名</p>\n","children":[]},{"key":"contents.items.attachments.items.file_size","name":"file_size","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"<p>文件大小</p>\n","children":[]},{"key":"contents.items.attachments.items.s3_file","name":"s3_file","deprecated":false,"type":"object","required":"是","enum":[],"xEnum":[],"description":"<p>云文档文件数据,store_type为s3_file时必填</p>\n","children":[{"key":"contents.items.attachments.items.s3_file.file_md5","name":"file_md5","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>文件md5</p>\n","children":[]},{"key":"contents.items.attachments.items.s3_file.link","name":"link","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>静态文件link,预留字段</p>\n","children":[]},{"key":"contents.items.attachments.items.s3_file.s3_file_type","name":"s3_file_type","deprecated":false,"type":"string","required":"是","enum":["image_file","normal_file","signature_image"],"xEnum":["image_file","normal_file","signature_image"],"description":"<p>s3文件类型</p>\n","children":[]},{"key":"contents.items.attachments.items.s3_file.store_key","name":"store_key","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>文件store_key</p>\n","children":[]},{"key":"contents.items.attachments.items.s3_file.thumb_store_key","name":"thumb_store_key","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>图片文件缩略图的store_key,当s3_file_type为image时必传</p>\n","children":[]}]},{"key":"contents.items.attachments.items.store_type","name":"store_type","deprecated":false,"type":"string","required":"是","enum":["drive_file","s3_file"],"xEnum":["drive_file","s3_file"],"description":"<p>存储类型</p>\n","children":[]}]},{"key":"contents.items.date_range","name":"date_range","deprecated":false,"type":"object","required":"否","enum":[],"xEnum":[],"description":"<p>如果控件是日期区间时，日期区间内容</p>\n","children":[{"key":"contents.items.date_range.duration","name":"duration","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>时长，时长有单位，单位为月/天/小时，由时间格式决定</p>\n","children":[]},{"key":"contents.items.date_range.end_time","name":"end_time","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>结束时间</p>\n","children":[]},{"key":"contents.items.date_range.end_time_extra","name":"end_time_extra","deprecated":false,"type":"string","required":"否","enum":[],"xEnum":[],"description":"<p>结束时间额外信息（时区或AM/PM）</p>\n","children":[]},{"key":"contents.items.date_range.start_time","name":"start_time","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>开始时间</p>\n","children":[]},{"key":"contents.items.date_range.start_time_extra","name":"start_time_extra","deprecated":false,"type":"string","required":"否","enum":[],"xEnum":[],"description":"<p>开始时间额外信息（时区或AM/PM）</p>\n","children":[]}]},{"key":"contents.items.id","name":"id","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>控件id,需要和审批定义保持一致</p>\n","children":[]},{"key":"contents.items.title","name":"title","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>控件标题</p>\n","children":[]},{"key":"contents.items.type","name":"type","deprecated":false,"type":"string","required":"是","enum":["text_type_input","text_type_area","text_type_file","rich_text","date","select","info","contact","multi_select","number","money","image","sender","date_range"],"xEnum":["text_type_input","text_type_area","text_type_file","rich_text","date","select","info","contact","multi_select","number","money","image","sender","date_range"],"description":"<p>控件类型</p>\n","children":[]},{"key":"contents.items.value","name":"value","deprecated":false,"type":"string","required":"否","enum":[],"xEnum":[],"description":"<p>控件值,视控件类型而定</p>\n","children":[]},{"key":"contents.items.values","name":"values","deprecated":false,"type":"array[string]","required":"否","enum":[],"xEnum":[],"description":"<p>控件内容,多选专用</p>\n","children":[]}]},{"key":"creator","name":"creator","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>创建者</p>\n","children":[]},{"key":"custom_form","name":"custom_form","deprecated":false,"type":"string","required":"否","enum":[],"xEnum":[],"description":"<p>业务自定义表单,对应条件里中的jsonpath</p>\n","children":[]},{"key":"dept_id","name":"dept_id","deprecated":false,"type":"string","required":"否","enum":[],"xEnum":[],"description":"<p>发起人所在部门id,多部门时必传</p>\n","children":[]}]' />

## 请求体示例
```json
{
  "approval_define_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": "image_file",
            "store_key": "string",
            "thumb_store_key": "string"
          },
          "store_type": "drive_file"
        }
      ],
      "date_range": {
        "duration": "string",
        "end_time": "string",
        "end_time_extra": "string",
        "start_time": "string",
        "start_time_extra": "string"
      },
      "id": "string",
      "title": "string",
      "type": "text_type_input",
      "value": "string",
      "values": [
        "string"
      ]
    }
  ],
  "creator": "string",
  "custom_form": "string",
  "dept_id": "string"
}
```

## 响应体(Response)
**HTTP状态码:** `200`<br/>
**响应体格式:** `application/json`
<OpenapiRenderTable hideHeaderKeys='required' dataSource='[{"key":"data","name":"data","deprecated":false,"type":"object","required":"是","enum":[],"xEnum":[],"description":"<p>模拟审批实例流程结果</p>\n","children":[{"key":"data.pending_nodes","name":"pending_nodes","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>经过的审批流程节点信息</p>\n","children":[{"key":"data.pending_nodes.items.approval_node","name":"approval_node","deprecated":false,"type":"object","required":"否","enum":[],"xEnum":[],"description":"<p>审批节点</p>\n","children":[{"key":"data.pending_nodes.items.approval_node.approval_rule","name":"approval_rule","deprecated":false,"type":"string","required":"否","enum":["step","or_sign","and_sign"],"xEnum":["step","or_sign","and_sign"],"description":"<p>审批规则，只有当审批/抄送用户是多人时赋值</p>\n","children":[]},{"key":"data.pending_nodes.items.approval_node.select_ranges","name":"select_ranges","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>人员选择范围</p>\n","children":[{"key":"data.pending_nodes.items.approval_node.select_ranges.items.select_type","name":"select_type","deprecated":false,"type":"string","required":"是","enum":["user","user_group"],"xEnum":["user","user_group"],"description":"<p>选择类型</p>\n","children":[]},{"key":"data.pending_nodes.items.approval_node.select_ranges.items.select_value","name":"select_value","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>可以是user_id/user_group_id</p>\n","children":[]}]},{"key":"data.pending_nodes.items.approval_node.select_type","name":"select_type","deprecated":false,"type":"string","required":"否","enum":["single_choice","multi_choice"],"xEnum":["single_choice","multi_choice"],"description":"<p>选择方式,单选/多选</p>\n","children":[]},{"key":"data.pending_nodes.items.approval_node.transferred_to_admin","name":"transferred_to_admin","deprecated":false,"type":"boolean","required":"否","enum":[],"xEnum":[],"description":"<p>是否已转交管理员</p>\n","children":[]},{"key":"data.pending_nodes.items.approval_node.user_empty_policy","name":"user_empty_policy","deprecated":false,"type":"string","required":"否","enum":["transfer_to_admin","auto_pass"],"xEnum":["transfer_to_admin","auto_pass"],"description":"<p>审批人为空时的策略</p>\n","children":[]},{"key":"data.pending_nodes.items.approval_node.user_list","name":"user_list","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>审批人员</p>\n","children":[{"key":"data.pending_nodes.items.approval_node.user_list.items.avatar","name":"avatar","deprecated":false,"type":"string","required":"否","enum":[],"xEnum":[],"description":"<p>用户或应用的头像</p>\n","children":[]},{"key":"data.pending_nodes.items.approval_node.user_list.items.company_id","name":"company_id","deprecated":false,"type":"string","required":"否","enum":[],"xEnum":[],"description":"<p>身份所归属的公司</p>\n","children":[]},{"key":"data.pending_nodes.items.approval_node.user_list.items.id","name":"id","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>身份ID</p>\n","children":[]},{"key":"data.pending_nodes.items.approval_node.user_list.items.name","name":"name","deprecated":false,"type":"string","required":"否","enum":[],"xEnum":[],"description":"<p>用户或应用的名称</p>\n","children":[]},{"key":"data.pending_nodes.items.approval_node.user_list.items.type","name":"type","deprecated":false,"type":"string","required":"是","enum":["user","sp","unknown"],"xEnum":["user","sp","unknown"],"description":"<p>身份类型</p>\n","children":[]}]},{"key":"data.pending_nodes.items.approval_node.user_type","name":"user_type","deprecated":false,"type":"string","required":"否","enum":["optional","self","leader","multi_leader","department_owner","multi_department_owner","user_group","assigner"],"xEnum":["optional","self","leader","multi_leader","department_owner","multi_department_owner","user_group","assigner"],"description":"<p>用户类型</p>\n","children":[]}]},{"key":"data.pending_nodes.items.cc_node","name":"cc_node","deprecated":false,"type":"object","required":"否","enum":[],"xEnum":[],"description":"<p>抄送节点</p>\n","children":[{"key":"data.pending_nodes.items.cc_node.is_allow_add_cc","name":"is_allow_add_cc","deprecated":false,"type":"boolean","required":"否","enum":[],"xEnum":[],"description":"<p>是否允许添加抄送人</p>\n","children":[]},{"key":"data.pending_nodes.items.cc_node.select_ranges","name":"select_ranges","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>人员选择范围</p>\n","children":[{"key":"data.pending_nodes.items.cc_node.select_ranges.items.select_type","name":"select_type","deprecated":false,"type":"string","required":"是","enum":["user","user_group"],"xEnum":["user","user_group"],"description":"<p>选择类型</p>\n","children":[]},{"key":"data.pending_nodes.items.cc_node.select_ranges.items.select_value","name":"select_value","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>可以是user_id/user_group_id</p>\n","children":[]}]},{"key":"data.pending_nodes.items.cc_node.user_list","name":"user_list","deprecated":false,"type":"array[object]","required":"是","enum":[],"xEnum":[],"description":"<p>抄送人员</p>\n","children":[{"key":"data.pending_nodes.items.cc_node.user_list.items.avatar","name":"avatar","deprecated":false,"type":"string","required":"否","enum":[],"xEnum":[],"description":"<p>用户或应用的头像</p>\n","children":[]},{"key":"data.pending_nodes.items.cc_node.user_list.items.company_id","name":"company_id","deprecated":false,"type":"string","required":"否","enum":[],"xEnum":[],"description":"<p>身份所归属的公司</p>\n","children":[]},{"key":"data.pending_nodes.items.cc_node.user_list.items.id","name":"id","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>身份ID</p>\n","children":[]},{"key":"data.pending_nodes.items.cc_node.user_list.items.name","name":"name","deprecated":false,"type":"string","required":"否","enum":[],"xEnum":[],"description":"<p>用户或应用的名称</p>\n","children":[]},{"key":"data.pending_nodes.items.cc_node.user_list.items.type","name":"type","deprecated":false,"type":"string","required":"是","enum":["user","sp","unknown"],"xEnum":["user","sp","unknown"],"description":"<p>身份类型</p>\n","children":[]}]},{"key":"data.pending_nodes.items.cc_node.user_type","name":"user_type","deprecated":false,"type":"string","required":"否","enum":["optional","self","leader","multi_leader","department_owner","multi_department_owner","user_group","assigner"],"xEnum":["optional","self","leader","multi_leader","department_owner","multi_department_owner","user_group","assigner"],"description":"<p>用户类型</p>\n","children":[]}]},{"key":"data.pending_nodes.items.id","name":"id","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>节点编号,同一树下唯一</p>\n","children":[]},{"key":"data.pending_nodes.items.name","name":"name","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>节点名称</p>\n","children":[]},{"key":"data.pending_nodes.items.task_type","name":"task_type","deprecated":false,"type":"string","required":"是","enum":["approval","cc","custom"],"xEnum":["approval","cc","custom"],"description":"<p>任务类型</p>\n","children":[]}]}]},{"key":"code","name":"code","deprecated":false,"type":"integer","required":"是","enum":[],"xEnum":[],"description":"-","children":[]},{"key":"msg","name":"msg","deprecated":false,"type":"string","required":"是","enum":[],"xEnum":[],"description":"<p>人可阅读的文本信息，可能会按不同的语言或地区返回不同的文本信息。</p>\n","children":[]}]' />

## 响应体示例
```json
{
  "data": {
    "pending_nodes": [
      {
        "approval_node": {
          "approval_rule": "step",
          "select_ranges": [
            {
              "select_type": "user",
              "select_value": "string"
            }
          ],
          "select_type": "single_choice",
          "transferred_to_admin": true,
          "user_empty_policy": "transfer_to_admin",
          "user_list": [
            {
              "avatar": "string",
              "company_id": "string",
              "id": "string",
              "name": "string",
              "type": "user"
            }
          ],
          "user_type": "optional"
        },
        "cc_node": {
          "is_allow_add_cc": true,
          "select_ranges": [
            {
              "select_type": "user",
              "select_value": "string"
            }
          ],
          "user_list": [
            {
              "avatar": "string",
              "company_id": "string",
              "id": "string",
              "name": "string",
              "type": "user"
            }
          ],
          "user_type": "optional"
        },
        "id": "string",
        "name": "string",
        "task_type": "approval"
      }
    ]
  },
  "code": 0,
  "msg": "string"
}
```