Skip to content

Flow API

工作流管理

  • API名称: 工作流管理
  • 请求方法: POST
  • 请求路径: /biz/workflow/admin
  • 请求参数:
    • id (string, optional): 工作流ID,更新时必填
    • Merchant (string, required): 商户ID
    • 其他工作流相关字段
  • 响应示例:
    json
    {
      "success": true,
      "data": {
        "msg": "新增工作流成功",
        "code": 200
      }
    }

工作流分页

  • API名称: 工作流分页查询
  • 请求方法: POST
  • 请求路径: /biz/workflow/page
  • 请求参数:
    • pageNumber (number, optional): 页码,默认为1
    • pageSize (number, optional): 每页数量,默认为15
    • 其他查询条件
  • 响应示例:
    json
    {
      "success": true,
      "data": {
        "Total": 10,
        "CurrPage": 1,
        "Data": [
          {
            "Id": "123",
            "Merchant": "456",
            "Name": "工作流示例"
          }
        ]
      }
    }

工作流节点管理

  • API名称: 工作流节点管理
  • 请求方法: POST
  • 请求路径: /biz/workflow/node/admin
  • 请求参数:
    • id (string, optional): 节点ID,更新时必填
    • Merchant (string, required): 商户ID
    • 其他节点相关字段
  • 响应示例:
    json
    {
      "success": true,
      "data": {
        "msg": "新增工作流节点成功",
        "code": 200
      }
    }

工作流节点列表

  • API名称: 工作流节点列表
  • 请求方法: POST
  • 请求路径: /biz/workflow/nodes/list
  • 请求参数:
    • pageNumber (number, optional): 页码,默认为1
    • pageSize (number, optional): 每页数量,默认为15
    • 其他查询条件
  • 响应示例:
    json
    {
      "success": true,
      "data": {
        "Total": 5,
        "CurrPage": 1,
        "Data": [
          {
            "Id": "123",
            "Merchant": "456",
            "Name": "节点示例"
          }
        ]
      }
    }

工作流表单管理

  • API名称: 工作流表单管理
  • 请求方法: POST
  • 请求路径: /biz/workflow/forms/admin
  • 请求参数:
    • id (string, optional): 表单ID,更新时必填
    • Merchant (string, required): 商户ID
    • 其他表单相关字段
  • 响应示例:
    json
    {
      "success": true,
      "data": {
        "msg": "新增工作流表单成功",
        "code": 200
      }
    }

工作流表单列表

  • API名称: 工作流表单列表
  • 请求方法: POST
  • 请求路径: /biz/forms/list
  • 请求参数:
    • pageNumber (number, optional): 页码,默认为1
    • pageSize (number, optional): 每页数量,默认为15
    • 其他查询条件
  • 响应示例:
    json
    {
      "success": true,
      "data": {
        "Total": 3,
        "CurrPage": 1,
        "Data": [
          {
            "Id": "123",
            "Merchant": "456",
            "Name": "表单示例",
            "Fields": []
          }
        ]
      }
    }

表单字段管理

  • API名称: 表单字段管理
  • 请求方法: POST
  • 请求路径: /biz/workflow/form/field/admin
  • 请求参数:
    • id (string, optional): 字段ID,更新时必填
    • form_id (string, required): 表单ID
    • 其他字段相关属性
  • 响应示例:
    json
    {
      "success": true,
      "data": {
        "msg": "新增工作流表单字段成功",
        "code": 200
      }
    }

工作流路径管理

  • API名称: 工作流路径管理
  • 请求方法: POST
  • 请求路径: /biz/workflow/line/handle
  • 请求参数:
    • workflow (string, required): 工作流ID
    • source (string, required): 源节点ID
    • target (string, required): 目标节点ID
    • form (string, optional): 表单ID
    • state (boolean, optional): 状态
  • 响应示例:
    json
    {
      "success": true,
      "data": {
        "msg": "创建新的工作流流程成功",
        "code": 200,
        "line": {
          "Id": "123",
          "Workflow": "456",
          "Source": "789",
          "Target": "012"
        }
      }
    }