伙伴云OpenAPI
  1. 流程
伙伴云OpenAPI
  • 开发指南
    • 开发前必读
    • 申请 API Key
    • 基本概念介绍
    • 数据筛选器
    • 更新日志
  • 工作区
    • 获取工作区列表
      GET
    • 获取工作区成员列表
      POST
  • 表格数据
    • 获取表格列表
      POST
    • 获取表格配置
      POST
    • 查询数据列表
      POST
    • 获取数据详情
      POST
    • 创建数据
      POST
    • 更新数据
      PUT
    • 删除数据
      DELETE
    • 批量创建数据
      POST
    • 批量更新或创建数据
      PUT
    • 批量删除数据
      DELETE
  • 数据仓库数据
    • 获取数据仓库表格列表
      POST
    • 获取数据仓库表格配置
      POST
    • 查询数据列表
      POST
    • 获取数据详情
      POST
    • 批量创建数据
      POST
    • 批量更新数据
      PUT
    • 根据数据ID列表更新成相同数据
      PUT
    • 批量删除数据
      DELETE
  • 流程
    • 获取流程列表
      POST
    • 查询流程实例列表
      POST
    • 获取流程实例详情
      GET
    • 获取流程实例的执行记录
      POST
    • 查询流程任务列表
      POST
    • 获取流程任务详情
      GET
  • 文件
    • 批量获取文件详情
    • 上传文件
  • 订阅
    • 订阅事件概述
    • Encrypt Key 加解密
    • 订阅回调事件
    • 添加订阅
    • 取消订阅
    • 获取订阅列表
  • 服务商
    • 获取 access_token
    • 获取服务商的 api_key
    • 获取服务商信息
    • 设置订阅回调地址
    • 获取订阅回调地址
  1. 流程

获取流程列表

POST
https://api.huoban.com/openapi/v1/procedure/list
获取指定工作区内的流程列表。

请求参数

Header 参数
Open-Authorization
string 
必需
授权的 API Key
默认值:
Bearer {{API_KEY}}
Body 参数application/json
space_id
string 
工作区ID
必需
仅支持查询指定工作区下的所有流程
table_id
string 
表格ID或别名
可选
按照表格ID查找绑定的流程,此时最多返回1个流程
status
string 
流程状态
可选
按照状态过滤返回的流程,启用:enable、禁用:disable
示例
{
  "space_id": "4000000000000001",
  "table_id": "2100000000000001",
  "status": "enable"
}

示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.huoban.com/openapi/v1/procedure/list' \
--header 'Open-Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "space_id": "4000000000000001",
    "table_id": "2100000000000001",
    "status": "enable"
}'

返回响应

🟢200成功
application/json
Body
code
integer 
错误码
必需
0 为成功,小于 10000 为系统异常,其他为业务异常
message
string 
错误信息
必需
具体的错误原因,code 为 0 时返回“success”
data
object 
返回数据
必需
返回具体数据的结构
procedures
array[object (流程) {8}] 
必需
meta
object 
元数据
必需
用来描述返回数据原始信息
trace_id
string 
请求ID
必需
每次请求接口会返回唯一的ID
示例
{
  "code": 0,
  "message": "success",
  "data": {
    "procedures": [
      {
        "procedure_id": "3000000000000001",
        "alias": "reimbursement",
        "name": "报销申请",
        "status": "enable",
        "created_on": "2025-04-24 09:52:38",
        "updated_on": "2025-04-24 09:52:38",
        "table_id": "2100000000000001",
        "space_id": "4000000000000001"
      }
    ]
  },
  "meta": {
    "trace_id": "1123912595092749"
  }
}
🔴500500错误
上一页
批量删除数据
下一页
查询流程实例列表
Built with