查询流程任务列表 - 伙伴云OpenAPI

请求参数

Header 参数

Open-Authorization

string

必需

授权的 API Key

默认值:

Bearer {{API_KEY}}

Body 参数application/json

space_id

string

工作区ID

可选

工作区ID、发起人ID、流程ID、流程实例ID必须提供一个，查询指定范围内的流程任务

executor_id

string

执行人ID

可选

工作区ID、发起人ID、流程ID、流程实例ID必须提供一个，查询指定范围内的流程任务

procedure_id

string

流程ID或别名

可选

工作区ID、发起人ID、流程ID、流程实例ID必须提供一个，查询指定范围内的流程任务，使用别名必传工作区ID

process_id

string

流程实例ID

可选

工作区ID、发起人ID、流程ID、流程实例ID必须提供一个，查询指定范围内的流程任务

status

string

任务状态

可选

按照状态过滤返回的流程任务，执行中：executing、异常中：exception、已完成（同意）：agreed、已完成（不同意）rejected、已取消：cancel

startdate

string

开始日期

可选

按照任务创建时间，大于等于开始日期，过滤返回的流程任务

enddate

string

结束日期

可选

按照任务创建时间，小于等于结束日期，过滤返回的流程任务

limit

integer

每页条数

可选

默认 20 条，最大 100 条

offset

integer

分页偏移量

可选

默认为 0

示例

{
  "space_id": "4000000000000001",
  "executor_id": "1000001",
  "procedure_id": "3000000000000001",
  "process_id": "4600000000000001",
  "status": "executing",
  "startdate": "2024-07-11 21:25:55",
  "enddate": "2024-10-31 21:07:25",
  "limit": 20,
  "offset": 0
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.huoban.com/openapi/v1/task/list' \
--header 'Open-Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "space_id": "4000000000000001",
    "executor_id": "1000001",
    "procedure_id": "3000000000000001",
    "process_id": "4600000000000001",
    "status": "executing",
    "startdate": "2024-07-11 21:25:55",
    "enddate": "2024-10-31 21:07:25",
    "limit": 20,
    "offset": 0
}'

返回响应

🟢200成功

application/json

Body

code

integer

错误码

必需

0 为成功，小于 10000 为系统异常，其他为业务异常

message

string

错误信息

必需

具体的错误原因，code 为 0 时返回“success”

data

object

返回数据

必需

返回具体数据的结构

total

integer

数据总数

必需

基于给定的工作区ID、发起人ID、流程ID、流程实例ID可查出的数据总数

filtered

integer

筛选出的数据总数

必需

其他参数对total筛选出的数据总数

tasks

array[object (流程任务) {15}]

流程任务

必需

meta

object

元数据

必需

用来描述返回数据原始信息

trace_id

string

请求ID

必需

每次请求接口会返回唯一的ID

示例

{
  "code": 0,
  "message": "success",
  "data": {
    "total": 100,
    "filtered": 20,
    "tasks": [
      {
        "task_id": "337206197",
        "process_id": "4600000000000001",
        "procedure_id": "3000000000000001",
        "procedure_name": "设备申请",
        "space_id": "4000000000000001",
        "status": "agreed",
        "created_on": "2025-04-25 10:25:11",
        "completed_on": "2025-04-25 10:25:21",
        "duration": 10,
        "process_executor": {
          "user_id": "1768441",
          "name": "孙超",
          "avatar": "https://hb-v4-public-oss.huoban.com/user_avatar/1088519/0?imageMogr2/thumbnail/128x128>"
        },
        "item": {
          "table_id": "2100000034917588",
          "item_id": "2300000057051231",
          "title": "姜伟的设备申请"
        },
        "element_name": "经理审批",
        "type": "view_item",
        "task_executor": {
          "user_id": "1717730",
          "name": "毛强",
          "avatar": "https://hb-v4-public-oss.huoban.com/user_avatar/1045784/0?imageMogr2/thumbnail/128x128>"
        },
        "task_item": {
          "table_id": "2100000034917588",
          "item_id": "2300000057051231",
          "title": "姜伟的设备申请"
        }
      }
    ]
  },
  "meta": {
    "trace_id": "7184045479361575"
  }
}

🔴500500错误