Skip to content

获取可用工作流列表

📋 接口说明

此接口用于获取所有已发布的工作流,返回工作流的基本信息和参数定义。

接口描述

获取全部可用的 Workflow 列表,支持分页查询。

请求方式

GET https://newapi.iflyrpa.com/api/rpa-openapi/workflows/get
GET https://newapi.iflyrpa.com/api/rpa-openapi/workflows/get?pageNo=1&pageSize=10

认证要求

需要带 BEARER TOKEN

请在请求头中添加:

Authorization: Bearer {YOUR_API_KEY}

查询参数

参数名类型必填说明
pageNoInteger页码,从 1 开始
pageSizeInteger每页数量

响应格式

成功响应 (HTTP 200)

json
{
  "code": "0000",
  "msg": "",
  "data": {
    "total": 2,
    "records": [
      {
        "project_id": "1966016474983485440",
        "name": "长时间",
        "english_name": "longtime",
        "description": "longtime",
        "version": 1,
        "status": 1,
        "parameters": [],
        "user_id": "a6a60f75-626a-4ba0-bd7e-799c8404aa6b",
        "created_at": "2025-09-11T13:51:39",
        "updated_at": "2025-09-11T13:51:39"
      },
      {
        "project_id": "1965981379635499008",
        "name": "创建文件",
        "english_name": "create_file",
        "description": "用于创建文件",
        "version": 1,
        "status": 1,
        "parameters": [
          {
            "id": "1966013517340659712",
            "varDirection": 0,
            "varName": "content",
            "varType": "Str",
            "varValue": "默认值",
            "varDescribe": "",
            "processId": "1965981379643887616"
          }
        ],
        "user_id": "a6a60f75-626a-4ba0-bd7e-799c8404aa6b",
        "created_at": "2025-09-11T13:42:32",
        "updated_at": "2025-09-11T13:42:32"
      }
    ]
  }
}

响应字段说明

顶层字段

字段名类型说明
codeString响应代码,"0000" 表示成功
msgString响应消息
dataObject返回的数据对象

data 字段

字段名类型说明
totalInteger工作流总数
recordsArray工作流列表

records 数组中的字段

字段名类型说明
project_idString工作流项目ID
nameString工作流名称
english_nameString工作流英文名称
descriptionString工作流描述
versionInteger工作流版本号
statusInteger工作流状态(1 为正常)
parametersArray工作流参数列表
user_idString创建者用户ID
created_atString创建时间(ISO 8601 格式)
updated_atString最后更新时间(ISO 8601 格式)

parameters 数组中的字段

字段名类型说明
idString参数ID
varDirectionInteger参数方向(0 为输入)
varNameString参数名称
varTypeString参数类型,支持以下类型:
- Str 字符串
- Float 浮点数
- Int 整数
- PATH 文件路径
- DIRPATH 文件夹路径
- Date 日期
- Password 密码
varValueDynamic参数默认值,类型与 varType 对应
varDescribeString参数描述
processIdString所属流程ID

请求示例

cURL

bash
curl -X GET "https://newapi.iflyrpa.com/api/rpa-openapi/workflows/get?pageNo=1&pageSize=10" \
  -H "Authorization: Bearer {YOUR_API_KEY}"

Python

python
import requests

url = "https://newapi.iflyrpa.com/api/rpa-openapi/workflows/get"
params = {
    "pageNo": 1,
    "pageSize": 10
}
headers = {
    "Authorization": "Bearer {YOUR_API_KEY}"
}

response = requests.get(url, params=params, headers=headers)
data = response.json()
print(data)

JavaScript

javascript
const apiKey = "{YOUR_API_KEY}";
const url = "https://newapi.iflyrpa.com/api/rpa-openapi/workflows/get?pageNo=1&pageSize=10";

fetch(url, {
  method: "GET",
  headers: {
    "Authorization": `Bearer ${apiKey}`
  }
})
  .then(response => response.json())
  .then(data => console.log(data))
  .catch(error => console.error("Error:", error));