三方审批实例同步

审批中心不负责审批的流转，审批的流转在三方系统，三方系统在审批流转后生成的审批实例、审批任务、审批抄送数据同步到审批中心。

第三方将生成的审批通过该接口将数据同步/更新至Boss Hi审批中，实现各个第三方审批数据的聚合

请求

基本
HTTP URL	https://hi-qa.weizhipin.com/open-apis/approval/external_instances
HTTP Method	POST
支持的应用类型	自建应用 商店应用
权限要求	向官方审批同步数据

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560"
Content-Type	string	是	固定值："application/json; charset=utf-8"

请求体

名称	类型	必填	描述
approval_code	string	是	审批定义 code
biz_name	string	是	列表中用于提示审批来自哪里， 注意不需要“来自”前缀，审批中心会拼上前缀
status	string	是	审批实例状态 示例值："PENDING" 可选值有： * PENDING：审批中 * APPROVED：审批流程结束，结果为同意 * REJECTED：审批流程结束，结果为拒绝 * CANCELED：审批发起人撤回 * DELETED：审批被删除
extra	string	否	审批实例扩展 JSON 示例值："{"xxx":"xxx"}"
instance_id	string	是	审批实例唯一标识，用户自定义，需确保证租户、应用下唯一 示例值："24492654"
link	external_instance_link	是	审批实例链接集合 ，用于【已发起】列表的跳转，跳转回三方系统； pc_link 和 mobile_link 必须填一个
∟pc_link	string	是	pc 端的跳转链接 pc跳转链接和移动端跳转链接必须有一个不为空
∟mobile_link	string	否	移动端 跳转链接 pc跳转链接和移动端跳转链接必须有一个不为空
title	string	是	审批展示名称
user_id	string	是	审批发起人 user_id，发起人可在【已发起】列表中看到所有已发起的审批; 在【待审批】，【已审批】【抄送我】列表中，该字段展示审批是谁发起的。 示例值："a987sf9s"
user_name	string	是	审批发起人 用户名，如果发起人不是真实的用户（例如是某个部门），没有 user_id，则可以使用该字段传名称 示例值："@i18n@9"
start_time	string	是	审批发起时间 示例值："2022-08-05 00:00:00"
end_time	string	否	审批实例结束时间 示例值："2022-08-05 00:00:00"
update_time	string	是	审批实例最近更新时间；
action_callback_url	string	否	快捷审批回调链接，当用户点击同意或拒绝时通过该链接回调第三方系统
task_list	external_instance_task_node[]	否	任务列表
∟task_id	string	是	审批实例内的唯一标识，用于更新审批任务时定位数据
∟user_id	string	是	审批人 user_id，该任务会出现在审批人的【待审批】或【已审批】列表中
∟title	string	是	审批任务名称
∟link	external_instance_link	是	审批实例链接集合 ，用于【待处理】列表的跳转，跳转回三方系统； pc_link 和 mobile_link 必须填一个
∟pc_link	string	是	pc 端的跳转链接 pc跳转链接和移动端跳转链接必须有一个不为空
∟mobile_link	string	否	移动端 跳转链接 pc跳转链接和移动端跳转链接必须有一个不为空
∟status	string	是	任务状态 可选值有： * PENDING：待审批 * APPROVED：任务同意 * REJECTED： 任务拒绝
∟update_time	string	是	审批任务最近更新时间
∟read_status	string	否	已读状态 可选值有： * READ：已读 * UNREAD：未读
∟display_method	string	否	链接打开方式 可选值有： * BROWSER：跳转系统默认浏览器打开 * SIDEBAR：hi中侧边抽屉打开
∟fast_approval	stirng	否	是否允许快捷审批 默认值："ALL" 可选值有： * NOT：不允许快捷审批 * APPROVED：仅支持同意 * REJECTED：仅支持拒绝 * ALL：都支持
∟fast_reason	stirng	否	是否填写快捷审批意见 默认值："NONE" 可选值有： * APPROVED_REQUIRED：同意时必填原因 * REJECTED_REQUIRED：拒绝时必填原因 * ALL：同意拒绝均需要填写原因 * NONE：均不必填
cc_list	cc_node[]	否	抄送列表
∟id	string	是	审批实例内的唯一标识，用于更新审批任务时定位数据
∟user_id	string	是	抄送人 user_id，该任务会出现在抄送的人【抄送我】列表中
∟title	string	是	审批任务名称
∟link	external_instance_link	是	审批实例链接集合
∟pc_link	string	是	pc 端的跳转链接 pc跳转链接和移动端跳转链接必须有一个不为空
∟mobile_link	string	否	移动端 跳转链接 pc跳转链接和移动端跳转链接必须有一个不为空
∟update_time	string	是	审批任务最近更新时间
∟read_status	string	否	已读状态 可选值有： * READ：已读 * UNREAD：未读
∟display_method	string	否	链接打开方式 可选值有： * BROWSER：跳转系统默认浏览器打开 * SIDEBAR：hi中侧边抽屉打开
remind_list	cc_node[]	否	@我的列表
∟id	string	是	审批实例内的唯一标识，用于更新审批任务时定位数据
∟user_id	string	是	@人 user_id，该任务会出现在【@我的】列表中
∟title	string	是	审批任务名称
∟link	external_instance_link	是	审批实例链接集合
∟pc_link	string	是	pc 端的跳转链接 pc跳转链接和移动端跳转链接必须有一个不为空
∟mobile_link	string	否	移动端 跳转链接 pc跳转链接和移动端跳转链接必须有一个不为空
∟update_time	string	是	审批任务最近更新时间
∟read_status	string	否	已读状态 可选值有： * READ：已读 * UNREAD：未读
∟display_method	string	否	链接打开方式 可选值有： * BROWSER：跳转系统默认浏览器打开 * SIDEBAR：hi中侧边抽屉打开
display_method	string	否	链接打开方式 可选值有： * BROWSER：跳转系统默认浏览器打开 * SIDEBAR：hi中侧边抽屉打开
approval_type	string	否	审批类型，如请假、公出等
buttons	third_custom_button[]	否	更多操作，在列表中增加操作按钮，最多4个
∟button_name	string	是	在Boss Hi上看到的更多操作的名称
∟button_type	string	是	操作类型，回调时返回给第三方
∟button_url	string	是	更多操作回调的URL
fast_approval	stirng	否	是否允许快捷审批 默认值："ALL" 可选值有： * NOT：不允许快捷审批 * APPROVED：仅支持同意 * REJECTED：仅支持拒绝 * ALL：都支持
fast_reason	stirng	否	是否填写快捷审批意见 默认值："NONE" 可选值有： * APPROVED_REQUIRED：同意时必填原因 * REJECTED_REQUIRED：拒绝时必填原因 * ALL：同意拒绝均需要填写原因 * NONE：均不必填

请求体示例

{
  "approval_code": "84C18825-A3D2",
  "biz_name":"BPM",
  "instance_id": "3162634111",
  "status": "PENDING",
  "extra": "{\"审批类型\":\"请假\"}",
  "link": {
    "pc_link": "http://",
    "mobile_link": "http://"
  },
  "title": "三方审批",
  "user_id": "12945",
  "user_name": "张三",
  "start_time": "2022-08-03 15:28:43",
  "update_time": "2022-08-03 15:28:43",
  "end_time": "2022-08-03 15:28:43",
  "action_callback_url":"11111",
  "task_list": [{
    "task_id": "112253",
    "user_id": "12945",
    "link": {
      "pc_link": "http://",
      "mobile_link": "http://"
    },
    "status": "PENDING",
    "title": "同意",
    "update_time": "2022-08-03 15:28:43",
    "read_status":"READ",
    "display_method":"BROWSER"
  }],
  "cc_list": [{
    "id": "112253",
    "user_id": "12945",
    "link": {
      "pc_link": "http://",
      "mobile_link": "http://"
    },
    "title": "同意",
    "update_time": "2022-08-03 15:28:43",
    "read_status":"READ",
    "display_method":"BROWSER"
  }],
  "remind_list": [{
    "id": "112253",
    "user_id": "12945",
    "link": {
      "pc_link": "http://",
      "mobile_link": "http://"
    },
    "title": "同意",
    "update_time": "2022-08-03 15:28:43",
    "read_status":"READ",
    "display_method":"BROWSER"
  }],
  "buttons":[{
    "button_name":"按钮测试",
    "button_type":"test",
    "button_url":"111122"
  }],
  "approval_type":"请假",
  "display_method":"BROWSER"
}

响应

响应体

名称	类型	必填	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	-	-
∟approval_code	string	是	审批定义 code
∟biz_name	string	是	列表中用于提示审批来自哪里， 注意不需要“来自”前缀，审批中心会拼上前缀
∟status	string	是	审批实例状态 示例值："PENDING" 可选值有： * PENDING：审批中 * APPROVED：审批流程结束，结果为同意 * REJECTED：审批流程结束，结果为拒绝 * CANCELED：审批发起人撤回 * DELETED：审批被删除
∟extra	string	否	审批实例扩展 JSON 示例值："{"xxx":"xxx"}"
∟instance_id	string	是	审批实例唯一标识，用户自定义，需确保证租户、应用下唯一 示例值："24492654"
∟links	external_instance_link	是	审批实例链接集合 ，用于【已发起】列表的跳转，跳转回三方系统； pc_link 和 mobile_link 必须填一个
∟pc_link	string	是	pc 端的跳转链接
∟mobile_link	string	否	移动端 跳转链接
∟title	string	是	审批展示名称
∟user_id	string	否	审批发起人 user_id，发起人可在【已发起】列表中看到所有已发起的审批; 在【待审批】，【已审批】【抄送我】列表中，该字段展示审批是谁发起的。 示例值："a987sf9s"
∟user_name	string	否	审批发起人 用户名，如果发起人不是真实的用户（例如是某个部门），没有 user_id，则可以使用该字段传名称 示例值："@i18n@9"
∟start_time	string	是	审批发起时间 示例值："2022-08-05 00:00:00"
∟end_time	string	是	审批实例结束时间：未结束的审批为 0 示例值："2022-08-05 00:00:00"
∟update_time	string	是	审批实例最近更新时间；
∟action_callback_url	string	否	快捷审批回调链接，当用户点击同意或拒绝时通过该链接回调第三方系统
∟task_list	external_instance_task_node[]	否	任务列表
∟task_id	string	是	审批实例内的唯一标识，用于更新审批任务时定位数据
∟user_id	string	是	审批人 user_id，该任务会出现在审批人的【待审批】或【已审批】列表中
∟title	string	是	审批任务名称
∟link	external_instance_link	是	审批实例链接集合 ，用于【待处理】列表的跳转，跳转回三方系统； pc_link 和 mobile_link 必须填一个
∟pc_link	string	是	pc 端的跳转链接
∟mobile_link	string	否	移动端 跳转链接
∟status	string	是	任务状态 可选值有： * PENDING：待审批 * APPROVED：任务同意 * REJECTED： 任务拒绝
∟updateTime	string	是	审批任务最近更新时间
∟read_status	string	否	已读状态 可选值有： * READ：已读 * UNREAD：未读
∟display_method	string	否	链接打开方式 可选值有： * BROWSER：跳转系统默认浏览器打开 * SIDEBAR：hi中侧边抽屉打开
∟cc_list	cc_node[]	否	抄送列表
∟id	string	是	审批实例内的唯一标识，用于更新审批任务时定位数据
∟user_id	string	是	抄送人 user_id，该任务会出现在抄送的人【抄送我】列表中
∟title	string	否	审批任务名称
∟link	external_instance_link	是	审批实例链接集合
∟pc_link	string	是	pc 端的跳转链接
∟mobile_link	string	否	移动端 跳转链接
∟update_time	string	是	审批任务最近更新时间
∟read_status	string	否	已读状态 可选值有： * READ：已读 * UNREAD：未读
∟display_method	string	否	链接打开方式 可选值有： * BROWSER：跳转系统默认浏览器打开 * SIDEBAR：hi中侧边抽屉打开
∟remind_list	cc_node[]	否	抄送列表
∟id	string	是	审批实例内的唯一标识，用于更新审批任务时定位数据
∟user_id	string	是	@人 user_id，该任务会出现在【@我的】列表中
∟title	string	否	审批任务名称
∟link	external_instance_link	是	审批实例链接集合
∟pc_link	string	是	pc 端的跳转链接
∟mobile_link	string	否	移动端 跳转链接
∟update_time	string	是	审批任务最近更新时间
∟action_config	boolean	否	是否使用快捷审批
∟read_status	string	否	已读状态 可选值有： * READ：已读 * UNREAD：未读
∟display_method	string	否	链接打开方式 可选值有： * BROWSER：跳转系统默认浏览器打开 * SIDEBAR：hi中侧边抽屉打开
display_method	string	否	链接打开方式 可选值有： * BROWSER：跳转系统默认浏览器打开 * SIDEBAR：hi中侧边抽屉打开
approval_type	string	否	审批类型，如请假、公出等
buttons	third_custom_button[]	否	更多操作，在列表中增加操作按钮，最多4个
∟button_name	string	是	在Boss Hi上看到的更多操作的名称
∟button_type	string	是	操作类型，回调时返回给第三方
∟button_url	string	是	更多操作回调的URL

响应体示例

{
  "approval_code": "84C18825-A3D2",
  "biz_name":"BPM",
  "instance_id": "3162634111",
  "status": "PENDING",
  "extra": "{\"审批类型\":\"请假\"}",
  "link": {
    "pc_link": "http://applink-bosshi.zhipin.com/sso/common?redirectUrl=/seeyon/main.do?method=main&client=pc",
    "mobile_link": "http://applink-bosshi.zhipin.com/sso/common?redirectUrl=/seeyon/main.do?method=main&client=pc"
  },
  "title": "三方审批",
  "user_id": "12945",
  "user_name": "张三",
  "start_time": "2022-08-03 15:28:43",
  "update_time": "2022-08-03 15:28:43",
  "end_time": "2022-08-03 15:28:43",
  "action_callback_url":"11111",
  "task_list": [{
    "task_id": "112253",
    "user_id": "12945",
    "link": {
      "pc_link": "http://applink-bosshi.zhipin.com/sso/common?redirectUrl=/seeyon/main.do?method=main&client=pc",
      "mobile_link": "http://applink-bosshi.zhipin.com/sso/common?redirectUrl=/seeyon/main.do?method=main&client=pc"
    },
    "status": "PENDING",
    "title": "同意",
    "update_time": "2022-08-03 15:28:43",
    "read_status":"READ",
    "display_method":"BROWSER"
  }],
  "cc_list": [{
    "id": "112253",
    "user_id": "12945",
   "link": {
      "pc_link": "http://applink-bosshi.zhipin.com/sso/common?redirectUrl=/seeyon/main.do?method=main&client=pc",
      "mobile_link": "http://applink-bosshi.zhipin.com/sso/common?redirectUrl=/seeyon/main.do?method=main&client=pc"
    },
    "title": "同意",
    "update_time": "2022-08-03 15:28:43",
    "read_status":"READ",
    "display_method":"BROWSER"
  }],
  "remind_list": [{
    "id": "112253",
    "user_id": "12945",
    "link": {
      "pc_link": "http://applink-bosshi.zhipin.com/sso/common?redirectUrl=/seeyon/main.do?method=main&client=pc",
      "mobile_link": "http://applink-bosshi.zhipin.com/sso/common?redirectUrl=/seeyon/main.do?method=main&client=pc"
    },
    "title": "同意",
    "update_time": "2022-08-03 15:28:43",
    "read_status":"READ",
    "display_method":"BROWSER"
  }],
  "buttons":[{
    "button_name":"按钮测试",
    "button_type":"test",
    "button_url":"111122"
  }],
  "approval_type":"请假",
  "display_method":"BROWSER"
}