Developer OpenAPI
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
首页Apifox官网钉钉openAPI
企业微信openAPI
  • openAPI文档
  • 官方文档
新版服务端API（DingTalk OpenAPI）
  • 历史文档（不推荐）
  • 开发钉钉应用
  • 服务端API
  • 新版服务端API（DingTalk OpenAPI）
  • 生态伙伴API
获取访问凭证通讯录应用市场客户管理服务群考勤待办任务日程钉盘会议专属钉钉合作空间钉工牌数据目录制造业数字化管理师宜搭应用开发文档
获取访问凭证通讯录应用市场客户管理服务群考勤待办任务日程钉盘会议专属钉钉合作空间钉工牌数据目录制造业数字化管理师宜搭应用开发文档
  1. 表单
  • 流程
    • 发起宜搭审批流程
      POST
    • 更新流程实例
      PUT
    • 删除流程实例
      DELETE
    • 终止流程实例
      PUT
    • 获取流程设计的节点信息
      GET
    • 获取流程节点按钮列表
      GET
  • 任务
    • 获取流程实例
      POST
    • 获取审批记录
      GET
    • 执行审批任务
      POST
    • 获取组织内某人提交的任务
      GET
    • 获取组织内已完成的审批任务
      GET
    • 转交任务
      POST
    • 获取实例ID列表
      POST
    • 查询流程运行任务（VPC）
      GET
    • 批量获取流程实例列表
      GET
    • 获取任务列表（组织维度）
      GET
    • 获取发送给用户的通知
      GET
    • 根据流程实例ID获取流程实例
      GET
    • 查询抄送我的任务列表（应用维度）
      GET
    • 执行宜搭的审批任务
      POST
    • 提交评论
      POST
  • 表单
    • 查询表单实例数据
      POST
    • 保存表单数据
      POST
    • 更新表单数据
      PUT
    • 删除表单数据
      DELETE
    • 查询表单数据
      GET
    • 删除序列
      DELETE
    • 更新状态
      PUT
    • 获取员工组件的值
      POST
    • 获取表单组件定义列表
      GET
    • 获取子表组件数据
      GET
    • 获取流程定义
      GET
    • 获取多个表单实例ID
      POST
  • 应用
    • 获取平台资源
    • 批量发起回调
    • 列出插件信息
    • 查询插件信息列表
    • 查询应用信息列表
    • 批量获取应用信息
    • 新购宜搭产品
  • 权益
    • 应用授权校验
    • 新购授权订单
    • 校验变配
    • 校验订单
    • 通过调用者unionId获取激活码
    • 通知授权结果
    • 变配租户信息
    • 查询商品列表
    • 注册账号
    • 验证激活结果
    • 校验订单的升级状态
    • 续费服务订单
    • 终止阿里云授权
    • 移除租户资源
    • 续费租户
    • 变更账号租户信息
  • 附件
    • 获取宜搭附件临时免登地址
  • 其他接口
    • 获取平台服务资源
    • 获取应用下的页面列表
    • 多渠道新购校验
    • 执行自定义API
    • 查询激活码
    • 查询销售用户信息
    • 查询企业级别
    • 校验订单的升级
    • 发布商品
    • 使商品过期
    • 退还商品
  1. 表单

获取流程定义

GET
http://127.0.0.1/v1.0/yida/processes/definitions/{processInstanceId}
新版服务端API（DingTalk OpenAPI）/宜搭应用开发/表单
最后修改时间：2022-08-30 09:19:23
责任人：未设置

说明#

调用本接口获取流程定义。
服务地址：api.dingtalk.com

权限#

要调用此API，需要以下权限之一。
应用类型是否支持权限API Explorer调试
企业内部应用支持宜搭流程数据读权限API Explorer
第三方企业应用支持宜搭流程数据读权限API Explorer
第三方个人应用暂不支持宜搭流程数据读权限暂不支持

错误码#

HttpCode错误码错误信息说明
400invalidParameter.methodInputs.invalidFormat数据格式错误:%s数据格式错误
400invalidParameter.number.exceed数字超过限制:%s数字超过限制
400invalidParameter.methodInputs.invalid入参校验失败:%s入参校验失败
400dataNotExist.form.notExists表单不存在:%s表单不存在
500dataModified.form.formAlreadyModified实例数据已修改, 请刷新当前页面:%s实例数据已经修改
500unclassifiedError异常:%s通用异常信息

请求参数

Path 参数
processInstanceId
string 
流程实例ID。
可选
Query 参数
corpId
string 
可选
组织的corpId。
groupId
string 
组ID。
可选
appType
string 
应用ID。
可选
orderNumber
string 
订单号。
可选
systemType
string 
应用的秘钥。
可选
systemToken
string 
可选
应用秘钥，在应用数据中获取。
nameSpace
string 
名称空间。
可选
language
string 
语言，取值：
可选
userId
string 
可选
用户的userid。
Header 参数
x-acs-dingtalk-access-token
string 
必需
调用该接口的访问凭证。如何获取不同应用的凭证请参考访问凭证概述。
Body 参数application/json
object {0}
示例
{}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'http://127.0.0.1/v1.0/yida/processes/definitions/{processInstanceId}' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{}'

返回响应

🟢200成功
application/json
Body
outResult
string 
审批结果，取值;
可选
processInstanceId
string 
流程实例ID。
可选
variables
object 
变量。
可选
formUuid
string 
表单ID。
可选
processId
string 
流程ID。
可选
owners
array [object {10}] 
所有者。
可选
userInfo
string 
用户信息。
可选
tbWang
string 
淘宝旺。
可选
orderNumber
string 
订单号。
可选
departmentDescription
string 
部门描述。
可选
displayName
string 
展示名称。
可选
masterDataDepartments
array [object {8}] 
主数据部门。
可选
displayEnName
string 
英文名称。
可选
userId
string 
用户userid。
可选
personalPhoto
string 
个人照片。
可选
status
string 
状态。
可选
originator
object 
创建者。
可选
userInfo
string 
用户信息。
可选
tbWang
string 
淘宝旺。
可选
orderNumber
string 
订单号。
可选
departmentDescription
string 
部门描述。
可选
displayName
string 
展示名称。
可选
masterDataDepartments
array [object {8}] 
主数据部门。
可选
displayEnName
string 
英文名称。
可选
userId
string 
可选
评论人钉钉的userId;
personalPhoto
string 
个人照片。
可选
status
string 
状态。
可选
title
string 
标题。
可选
tasks
array [object {4}] 
任务列表。
可选
actionerId
string 
执行人。
可选
activity
object 
流程信息。
可选
taskId
integer 
任务ID。
可选
status
string 
任务状态。
可选
status
string 
流程实例状态。
可选
示例
{
  "outResult": "string",
  "processInstanceId": "string",
  "variables": {},
  "formUuid": "string",
  "processId": "string",
  "owners": [
    {
      "userInfo": "string",
      "tbWang": "string",
      "orderNumber": "string",
      "departmentDescription": "string",
      "displayName": "string",
      "masterDataDepartments": [
        {
          "humanSourceGroupOrderNumber": "string",
          "deptPath": "string",
          "deptName": "string",
          "deptNameInEnglish": "string",
          "humanSourceGroupWorkNo": "string",
          "id": 0,
          "masterWorkNo": "string",
          "deptNo": "string"
        }
      ],
      "displayEnName": "string",
      "userId": "string",
      "personalPhoto": "string",
      "status": "string"
    }
  ],
  "originator": {
    "userInfo": "string",
    "tbWang": "string",
    "orderNumber": "string",
    "departmentDescription": "string",
    "displayName": "string",
    "masterDataDepartments": [
      {
        "humanSourceGroupOrderNumber": "string",
        "deptPath": "string",
        "deptName": "string",
        "deptNameInEnglish": "string",
        "humanSourceGroupWorkNo": "string",
        "id": 0,
        "masterWorkNo": "string",
        "deptNo": "string"
      }
    ],
    "displayEnName": "string",
    "userId": "string",
    "personalPhoto": "string",
    "status": "string"
  },
  "title": "string",
  "tasks": [
    {
      "actionerId": "string",
      "activity": {
        "activityName": "string",
        "activityNameInEnglish": "string",
        "activityId": "string",
        "id": 0,
        "activityInstanceStatus": "string"
      },
      "taskId": 0,
      "status": "string"
    }
  ],
  "status": "string"
}
上一页
获取子表组件数据
下一页
获取多个表单实例ID
Built with