Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
服务端API
  • 历史文档(不推荐)
  • 开发钉钉应用
  • 服务端API
  • 新版服务端API(DingTalk OpenAPI)
  • 生态伙伴API
获取凭证(access_token)身份验证(免登)应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理(官方CRM)培训智能硬件
获取凭证(access_token)身份验证(免登)应用授权通讯录管理互联平台群会话管理消息通知智能工作流智能填表智能人事考勤日志签到公告钉钉运动应用管理文件存储钉盘新教育专属钉钉智能办公电话应用市场项目管理客户管理(官方CRM)培训智能硬件
  1. 官方工作流
  • 自有工作流
    • 创建或更新审批模板
      POST
    • 获取模板code
      POST
    • 删除模板
      POST
    • 清理工作流数据
      POST
    • 创建实例
      POST
    • 更新实例状态
      POST
    • 批量更新实例状态
      POST
    • 创建待办事项
      POST
    • 查询待办列表
      POST
    • 更新待办状态
      POST
    • 批量取消待办
      POST
  • 官方工作流
    • 发起审批实例
      POST
    • 获取审批实例详情
      POST
    • 添加审批评论
      POST
    • 撤销审批实例
      POST
    • 获取审批实例ID列表
      POST
    • 获取用户待审批数量
      POST
    • 获取指定用户可见的审批表单列表
      POST
    • 查询已设置为条件的表单组件
      POST
    • 获取当前企业所有可管理的模版
      POST
    • 获取审批钉盘空间信息
      POST
    • 授权预览审批附件
      POST
    • 授权下载审批钉盘文件
      POST
    • 下载审批附件
      POST
    • 同意或拒绝审批任务
      POST
  1. 官方工作流

获取审批实例详情

POST
http://127.0.0.1/topapi/processinstance/get
服务端API/智能工作流/官方工作流
最后修改时间:2022-08-30 09:19:22
责任人:未设置

说明#

调用本接口根据审批实例ID,获取审批实例详情。详情包括审批表单信息、操作记录列表、操作人、抄送人、审批任务列表。
服务地址:https://oapi.dingtalk.com

权限#

服务端API是以应用维度授权的,在调用接口前,确保已经为应用添加了接口权限。详情请参考权限申请。
应用类型是否支持调用权限申请方式API Explorer调试
企业内部应用是开发者后台申请调试
第三方企业应用是开发者后台申请调试
第三方个人应用否——

请求参数

Query 参数
access_token
string 
必需
调用服务端API的应用凭证。企业内部应用可通过获取企业内部应用的access_token接口获取。第三方企业应用可通过获取第三方企业应用的access_token接口获取。
示例值:
6d1bxxxx
Body 参数application/json
process_instance_id
string 
必需
审批实例ID,可通过获取审批实例ID列表接口获取。
示例
{
  "process_instance_id": "1a2b-3e4dxxxx"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://127.0.0.1/topapi/processinstance/get?access_token=6d1bxxxx' \
--header 'Content-Type: application/json' \
--data-raw '{
    "process_instance_id": "1a2b-3e4dxxxx"
}'

返回响应

🟢200成功
application/json
Body
request_id
string 
请求ID。
可选
errcode
number 
返回码。
可选
errmsg
string 
返回码描述。
可选
process_instance
object 
审批实例详情。
可选
title
string 
审批实例标题。
可选
create_time
string 
开始时间。
可选
finish_time
string 
结束时间。
可选
originator_userid
string 
可选
发起人的userid。
originator_dept_id
string 
可选
发起人的部门。-1表示根部门。
status
string 
可选
审批状态:NEW:新创建RUNNING:审批中TERMINATED:被终止COMPLETED:完成CANCELED:取消
approver_userids
array[string]
可选
审批人userid。手动发起的审批单该参数才返回,使用接口发起的审批单该参数不返回。
cc_userids
array[string]
可选
抄送人userid。
result
string 
可选
审批结果:agree:同意refuse:拒绝
business_id
string 
审批实例业务编号。
可选
operation_records
array [object {6}] 
操作记录列表。
可选
tasks
array [object {7}] 
任务列表。
可选
originator_dept_name
string 
发起部门。
可选
biz_action
string 
可选
审批实例业务动作:MODIFY:表示该审批实例是基于原来的实例修改而来REVOKE:表示该审批实例是由原来的实例撤销后重新发起的NONE表示正常发起
attached_process_instance_ids
array[string]
可选
审批附属实例列表,当已经通过的审批实例被修改或撤销,会生成一个新的实例,作为原有审批实例的附属。如果想知道当前已经通过的审批实例的状态,可以依次遍历它的附属列表,查询里面每个实例的biz_action。
form_component_values
array [object {5}] 
表单详情列表。
可选
main_process_instance_id
string 
主流程实例标识。
可选
示例
{
  "request_id": "string",
  "errcode": 0,
  "errmsg": "string",
  "process_instance": {
    "title": "string",
    "create_time": "string",
    "finish_time": "string",
    "originator_userid": "string",
    "originator_dept_id": "string",
    "status": "string",
    "approver_userids": [
      "string"
    ],
    "cc_userids": [
      "string"
    ],
    "result": "string",
    "business_id": "string",
    "operation_records": [
      {
        "userid": "string",
        "date": "string",
        "operation_type": "string",
        "operation_result": "string",
        "remark": "string",
        "attachments": [
          {
            "file_name": "string",
            "file_size": "string",
            "file_id": "string",
            "file_type": "string"
          }
        ]
      }
    ],
    "tasks": [
      {
        "userid": "string",
        "task_status": "string",
        "task_result": "string",
        "create_time": "string",
        "finish_time": "string",
        "taskid": "string",
        "url": "string"
      }
    ],
    "originator_dept_name": "string",
    "biz_action": "string",
    "attached_process_instance_ids": [
      "string"
    ],
    "form_component_values": [
      {
        "name": "string",
        "value": "string",
        "ext_value": "string",
        "id": "string",
        "component_type": "string"
      }
    ],
    "main_process_instance_id": "string"
  }
}
上一页
发起审批实例
下一页
添加审批评论
Built with