接口文档

• 【Flexmodel】GraphQL
  • post执行GraphQL查询
• 【Flexmodel】任务
  • getFind Log Page
• 【Flexmodel】接口定义
  • get获取接口定义列表
  • post创建接口定义
  • post根据模型生成接口定义
  • getFind Api Definition Histories
  • post恢复接口定义
  • patch更新接口定义(局部更新)
  • put更新接口定义
  • del删除接口定义
• 【Flexmodel】接口文档
  • get获取接口文档
• 【Flexmodel】接口日志
  • get获取接口日志列表
  • get统计接口日志
• 【Flexmodel】数据源
  • get获取所有数据源
  • post创建数据源
  • post获取物理数据库表名称
  • post验证数据源连接
  • put更新数据源
  • del删除数据源
  • post导入模型到数据源
  • post执行原生查询
  • post从数据源同步物理表到建模
• 【Flexmodel】服务编排
  • get获取流程列表
  • post创建流程
  • get获取流程实例列表
  • post启动流程实例
  • get获取流程实例信息
  • post提交任务
  • get获取流程实例历史元素列表
  • post回滚任务
  • post终止流程实例
  • get获取流程实例历史用户任务列表
  • put更新流程
  • get获取流程模块信息
  • delDelete Flow
  • post部署流程
• 【Flexmodel】模型
  • get获取模型列表
  • post创建模型
  • postExecute Idl
  • put更新模型
  • get获取单个模型
  • del删除模型
  • post创建字段
  • put更新字段
  • del删除字段
  • post创建索引
  • put更新索引
  • del删除索引
• 【Flexmodel】生成器
  • getGet Templates
  • getGenerate
• 【Flexmodel】系统
  • get获取系统配置
• 【Flexmodel】系统监控
  • get获取所有监控指标
  • get获取CPU监控信息
  • get获取磁盘监控信息
  • getGet Fm Metrics
  • get获取JVM监控信息
  • get获取内存监控信息
  • get获取网络监控信息
  • get获取Prometheus格式指标
  • get获取系统摘要信息
  • get获取线程监控信息
• 【Flexmodel】触发器
  • get获取触发器列表
  • post创建触发器
  • put更新触发器
  • patch部分更新触发器
  • get获取单个触发器
  • del删除触发器
  • post立即执行触发器
• 【Flexmodel】记录
  • get获取模型数据记录列表
  • post创建模型数据记录
  • patch更新模型数据记录(局部更新)
  • put更新模型数据记录
  • get获取单条模型数据记录
  • del删除模型数据记录
• 【Flexmodel】设置
  • patch保存设置
  • get获取设置
• 【Flexmodel】身份源
  • get获取身份源列表
  • post创建身份源
  • put更新身份源
  • del删除身份源
• Ai Chat Resource
  • postChat Completions
  • getList Conversations
  • postCreate Conversation
  • getGet Conversation
  • delDelete Conversation
  • postSend Message
  • getList Messages
• Auth Resource
  • postLogin
  • postRefresh
  • getGet User Info
• Tenant Resource
  • getFind Tenants

API docs by Redocly

Flexmodel API (0.0.1)

Download OpenAPI specification:Download

FlexModel服务器API，提供模型管理和系统监控功能

【Flexmodel】GraphQL

GraphQL接口信息

执行GraphQL查询

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

operationName	string 操作名称
query	string 查询
	object 变量

Responses

https://preview.flexmodel.wetech.tech/api/f/graphql

Request samples

• Payload

Content type

application/json

{

• "operationName": "string",
• "query": "string",
• "variables": {

  • "property1": null,
  • "property2": null

  }

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "errors": [

  • {

    • "message": "string",
    • "locations": [

      • {

        • "line": 0,
        • "column": 0,
        • "sourceName": "string"

        }

      ],
    • "errorType": { },
    • "path": [

      • null

      ],
    • "extensions": {

      • "property1": null,
      • "property2": null

      }

    }

  ],
• "data": null,
• "dataPresent": true,
• "extensions": {

  • "property1": null,
  • "property2": null

  }

}

【Flexmodel】任务

任务管理

Find Log Page

Authorizations:

BearerAuth

query Parameters

endTime	string <date-time> (LocalDateTime) Examples: endTime=2022-03-10T12:15:50
isSuccess	boolean
jobId	string
page	integer <int32> Default: "1"
size	integer <int32> Default: "20"
startTime	string <date-time> (LocalDateTime) Examples: startTime=2022-03-10T12:15:50
status	string
triggerId	string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/jobs/logs

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "list": [

  • {

    • "id": "string",
    • "triggerId": "string",
    • "jobId": "string",
    • "jobGroup": "string",
    • "jobType": "string",
    • "jobName": "string",
    • "executionStatus": "string",
    • "startTime": "2022-03-10T12:15:50",
    • "endTime": "2022-03-10T12:15:50",
    • "executionDuration": 0,
    • "isSuccess": true,
    • "errorMessage": "string",
    • "errorStackTrace": null,
    • "inputData": null,
    • "outputData": null,
    • "retryCount": 0,
    • "maxRetryCount": 0,
    • "schedulerName": "string",
    • "instanceName": "string",
    • "firedTime": 0,
    • "scheduledTime": 0,
    • "tenantId": "string",
    • "createdBy": "string",
    • "updatedBy": "string",
    • "createdAt": "2022-03-10T12:15:50",
    • "updatedAt": "2022-03-10T12:15:50"

    }

  ],
• "total": 0

}

【Flexmodel】接口定义

接口定义管理

获取接口定义列表

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/apis

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "parentId": "string",
• "enabled": true,
• "method": "GET",
• "children": [

  • {

    • "id": "string",
    • "name": "string",
    • "parentId": "string",
    • "type": "FOLDER",
    • "method": "string",
    • "path": "string",
    • "meta": null,
    • "enabled": true,
    • "tenantId": "string",
    • "createdBy": "string",
    • "updatedBy": "string",
    • "createdAt": "2022-03-10T12:15:50",
    • "updatedAt": "2022-03-10T12:15:50",
    • "children": [

      • { }

      ]

    }

  ],
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

创建接口定义

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

id	string 唯一标识
type	string (ApiType) Enum: "FOLDER" "API" 类型, FOLDER: 文件夹；API: 接口
path	string 路径
meta	any 元数据，存放接口定义，例如graphql定义
name	string 名称
parentId	string 上级ID
enabled	boolean Default: true 是否开启
method	string HTTP请求方法
tenantId	string
createdBy	string
updatedBy	string

Responses

https://preview.flexmodel.wetech.tech/api/f/apis

Request samples

• Payload

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "parentId": "string",
• "enabled": true,
• "method": "GET",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "parentId": "string",
• "enabled": true,
• "method": "GET",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

根据模型生成接口定义

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

datasourceName required	string\S
modelName required	string\S
apiFolder required	string\S
idFieldOfPath required	string\S
generateAPIs required	Array of strings non-empty

Responses

https://preview.flexmodel.wetech.tech/api/f/apis/generate

Request samples

• Payload

Content type

application/json

{

• "datasourceName": "string",
• "modelName": "string",
• "apiFolder": "string",
• "idFieldOfPath": "string",
• "generateAPIs": [

  • "string"

  ]

}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

Find Api Definition Histories

Authorizations:

BearerAuth

path Parameters

apiDefinitionId required

string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/apis/{apiDefinitionId}/histories

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "id": "string",
  • "apiDefinitionId": "string",
  • "name": "string",
  • "parentId": "string",
  • "type": "FOLDER",
  • "method": "string",
  • "path": "string",
  • "meta": null,
  • "enabled": true,
  • "tenantId": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2022-03-10T12:15:50",
  • "updatedAt": "2022-03-10T12:15:50"

  }

]

恢复接口定义

Authorizations:

BearerAuth

path Parameters

apiDefinitionId required	string
historyId required	string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/apis/{apiDefinitionId}/histories/{historyId}/restore

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": "string",
• "apiDefinitionId": "string",
• "name": "string",
• "parentId": "string",
• "type": "FOLDER",
• "method": "string",
• "path": "string",
• "meta": null,
• "enabled": true,
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50"

}

更新接口定义(局部更新)

Authorizations:

BearerAuth

path Parameters

id required

string

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

id	string 唯一标识
type	string (ApiType) Enum: "FOLDER" "API" 类型, FOLDER: 文件夹；API: 接口
path	string 路径
meta	any 元数据，存放接口定义，例如graphql定义
name	string 名称
parentId	string 上级ID
enabled	boolean Default: true 是否开启
method	string HTTP请求方法
tenantId	string
createdBy	string
updatedBy	string

Responses

https://preview.flexmodel.wetech.tech/api/f/apis/{id}

Request samples

• Payload

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "parentId": "string",
• "enabled": true,
• "method": "GET",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "parentId": "string",
• "enabled": true,
• "method": "GET",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

更新接口定义

Authorizations:

BearerAuth

path Parameters

id required

string

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

id	string 唯一标识
type	string (ApiType) Enum: "FOLDER" "API" 类型, FOLDER: 文件夹；API: 接口
path	string 路径
meta	any 元数据，存放接口定义，例如graphql定义
name	string 名称
parentId	string 上级ID
enabled	boolean Default: true 是否开启
method	string HTTP请求方法
tenantId	string
createdBy	string
updatedBy	string

Responses

https://preview.flexmodel.wetech.tech/api/f/apis/{id}

Request samples

• Payload

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "parentId": "string",
• "enabled": true,
• "method": "GET",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": -1,
• "type": "FOLDER",
• "path": "string",
• "meta": null,
• "name": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "parentId": "string",
• "enabled": true,
• "method": "GET",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

删除接口定义

Authorizations:

BearerAuth

path Parameters

id required

string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/apis/{id}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

【Flexmodel】接口文档

接口文档管理

获取接口文档

Authorizations:

BearerAuth

path Parameters

tenantId required

string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/docs/{tenantId}/openapi.json

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "property1": null,
• "property2": null

}

【Flexmodel】接口日志

接口日志管理

获取接口日志列表

Authorizations:

BearerAuth

query Parameters

current	any Examples: 当前页，默认值：1
pageSize	any Examples: 第几页，默认值：15
keyword	string 关键字
dateRange	string Examples: 日期范围
level	any Examples: 日志等级
isSuccess	boolean
page	integer <int32> Default: 1
size	integer <int32> Default: 50

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/logs

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "total": null,
• "list": [

  • {

    • "id": "string",
    • "uri": null,
    • "level": null,
    • "createdAt": "2022-03-10T12:15:50",
    • "data": null,
    • "url": "string",
    • "httpMethod": "string",
    • "path": "string",
    • "requestBody": null,
    • "requestHeaders": null,
    • "statusCode": 0,
    • "responseTime": 0,
    • "clientIp": "string",
    • "isSuccess": true,
    • "errorMessage": null,
    • "tenantId": "string"

    }

  ]

}

统计接口日志

Authorizations:

BearerAuth

query Parameters

keyword	string 关键字
dateRange	string Examples: 日期范围
level	any Examples: 日志等级，支持传多个通过","分隔
isSuccess	boolean

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/logs/stat

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "date": "string",
  • "total": 0

  }

]

【Flexmodel】数据源

数据源管理

获取所有数据源

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "name": "string",
  • "type": "SYSTEM",
  • "config": { },
  • "enabled": true,
  • "createdAt": "2022-03-10T12:15:50",
  • "updatedAt": "2022-03-10T12:15:50",
  • "tenantId": "string",
  • "createdBy": "string",
  • "updatedBy": "string"

  }

]

创建数据源

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

name	string 名称，需要唯一
type	string (DatasourceType) Enum: "SYSTEM" "USER" 数据源类型
config	object 数据源配置
enabled	boolean 是否启用
tenantId	string
createdBy	string
updatedBy	string

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "SYSTEM",
• "config": { },
• "enabled": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "type": "SYSTEM",
• "config": { },
• "enabled": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

获取物理数据库表名称

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

name	string 名称，需要唯一
type	string (DatasourceType) Enum: "SYSTEM" "USER" 数据源类型
config	object 数据源配置
enabled	boolean 是否启用
tenantId	string
createdBy	string
updatedBy	string

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/physics/names

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "SYSTEM",
• "config": { },
• "enabled": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

[

• "string"

]

验证数据源连接

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

name	string 名称，需要唯一
type	string (DatasourceType) Enum: "SYSTEM" "USER" 数据源类型
config	object 数据源配置
enabled	boolean 是否启用
tenantId	string
createdBy	string
updatedBy	string

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/validate

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "SYSTEM",
• "config": { },
• "enabled": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "success": null,
• "errorMsg": null,
• "time": null

}

更新数据源

Authorizations:

BearerAuth

path Parameters

datasourceName required

string 数据源名称

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

name	string 名称，需要唯一
type	string (DatasourceType) Enum: "SYSTEM" "USER" 数据源类型
config	object 数据源配置
enabled	boolean 是否启用
tenantId	string
createdBy	string
updatedBy	string

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "SYSTEM",
• "config": { },
• "enabled": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "type": "SYSTEM",
• "config": { },
• "enabled": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

删除数据源

Authorizations:

BearerAuth

path Parameters

datasourceName required

string 数据源名称

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

导入模型到数据源

Authorizations:

BearerAuth

path Parameters

datasourceName required

string 数据源名称

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

script required	string\S 脚本
type	string (ImportScriptType) Enum: "JSON" "IDL" 脚本类型

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/import

Request samples

• Payload

Content type

application/json

{

• "script": "string",
• "type": "JSON"

}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

执行原生查询

Authorizations:

BearerAuth

path Parameters

datasourceName required

string 数据源名称

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

statement	string 语句
	object 参数

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/native-query

Request samples

• Payload

Content type

application/json

{

• "statement": "string",
• "parameters": {

  • "property1": null,
  • "property2": null

  }

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "time": null,
• "result": null

}

从数据源同步物理表到建模

Authorizations:

BearerAuth

path Parameters

datasourceName required

string 数据源名称

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

Array

string

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/sync

Request samples

• Payload

Content type

application/json

[

• "string"

]

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "type": "entity",
  • "name": "Student",
  • "fields": [

    • {

      • "name": "id",
      • "type": "Long",
      • "identity": true,
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "studentName",
      • "type": "String",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true,
      • "length": 255

      },
    • {

      • "name": "gender",
      • "type": "EnumRef",
      • "from": "UserGender",
      • "multiple": false,
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "interest",
      • "type": "EnumRef",
      • "from": "user_interest",
      • "multiple": true,
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "age",
      • "type": "Int",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "classId",
      • "type": "Long",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "studentDetail",
      • "type": "Relation",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true,
      • "multiple": false,
      • "from": "StudentDetail",
      • "localField": "id",
      • "foreignField": "studentId",
      • "cascadeDelete": true

      }

    ],
  • "indexes": [

    • {

      • "modelName": "Student",
      • "name": "IDX_studentName",
      • "fields": [

        • {

          • "fieldName": "studentName",
          • "direction": "ASC"

          }

        ],
      • "unique": false

      }

    ]

  }

]

【Flexmodel】服务编排

服务编排管理

获取流程列表

Authorizations:

BearerAuth

query Parameters

flowKey	string 流程模块ID
flowName	string 流程名称
page	integer <int32> Default: "1" 页码
size	integer <int32> Default: "20" 每页大小

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/flows

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "list": [

  • {

    • "flowModuleId": "flow_module_001",
    • "flowName": "订单处理流程",
    • "flowKey": "order_process",
    • "status": 4,
    • "remark": "处理订单的完整业务流程",
    • "tenant": "default",
    • "caller": "admin",
    • "operator": "admin",
    • "modifyTime": "2022-03-10T12:15:50"

    }

  ],
• "total": 100

}

创建流程

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

flowKey	string 流程键
flowName	string 流程名称
remark	string 备注
tenant	string 租户
caller	string 调用者
operator	string 操作者

Responses

https://preview.flexmodel.wetech.tech/api/f/flows

Request samples

• Payload

Content type

application/json

{

• "flowKey": "order_process",
• "flowName": "订单处理流程",
• "remark": "处理订单的完整业务流程",
• "tenant": "default",
• "caller": "admin",
• "operator": "admin"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "errCode": 0,
• "errMsg": "success",
• "flowModuleId": "flow_module_001"

}

获取流程实例列表

Authorizations:

BearerAuth

query Parameters

caller	string 调用者
flowDeployId	string 流程部署ID
flowInstanceId	string 流程实例ID
flowModuleId	string 流程模块ID
page	integer <int32> Default: "1" 页码
size	integer <int32> Default: "20" 每页大小
status	integer <int32> 流程实例状态

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/flows/instances

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "list": [

  • {

    • "flowInstanceId": "flow_inst_001",
    • "flowModuleId": "flow_module_001",
    • "flowDeployId": "flow_deploy_001",
    • "status": 1,
    • "parentFlowInstanceId": "parent_inst_001",
    • "tenant": "default",
    • "caller": "admin",
    • "operator": "admin",
    • "createTime": "2022-03-10T12:15:50",
    • "modifyTime": "2022-03-10T12:15:50"

    }

  ],
• "total": 100

}

启动流程实例

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

flowModuleId	string 流程模块ID
flowDeployId	string 流程部署ID
	object or array 流程变量
	object (RuntimeContext)

Responses

https://preview.flexmodel.wetech.tech/api/f/flows/instances/start

Request samples

• Payload

Content type

application/json

{

• "flowModuleId": "flow_module_001",
• "flowDeployId": "flow_deploy_001",
• "variables": {

  • "property1": null,
  • "property2": null

  },
• "runtimeContext": {

  • "parentRuntimeContext": { },
  • "flowDeployId": "string",
  • "flowModuleId": "string",
  • "tenantId": "string",
  • "caller": "string",
  • "flowElementMap": {

    • "property1": {

      • "key": "string",
      • "type": 0,
      • "outgoing": [

        • "string"

        ],
      • "properties": {

        • "property1": null,
        • "property2": null

        },
      • "incoming": [

        • "string"

        ]

      },
    • "property2": {

      • "key": "string",
      • "type": 0,
      • "outgoing": [

        • "string"

        ],
      • "properties": {

        • "property1": null,
        • "property2": null

        },
      • "incoming": [

        • "string"

        ]

      }

    },
  • "flowInstanceId": "string",
  • "flowInstanceStatus": 0,
  • "suspendNodeInstance": {

    • "id": 0,
    • "nodeInstanceId": "string",
    • "nodeKey": "string",
    • "sourceNodeInstanceId": "string",
    • "sourceNodeKey": "string",
    • "instanceDataId": "string",
    • "status": 0,
    • "nodeType": 0,
    • "properties": {

      • "property1": null,
      • "property2": null

      }

    },
  • "nodeInstanceList": [

    • {

      • "id": 0,
      • "nodeInstanceId": "string",
      • "nodeKey": "string",
      • "sourceNodeInstanceId": "string",
      • "sourceNodeKey": "string",
      • "instanceDataId": "string",
      • "status": 0,
      • "nodeType": 0,
      • "properties": {

        • "property1": null,
        • "property2": null

        }

      }

    ],
  • "suspendNodeInstanceStack": [

    • "string"

    ],
  • "currentNodeModel": {

    • "key": "string",
    • "type": 0,
    • "outgoing": [

      • "string"

      ],
    • "properties": {

      • "property1": null,
      • "property2": null

      },
    • "incoming": [

      • "string"

      ]

    },
  • "currentNodeInstance": {

    • "id": 0,
    • "nodeInstanceId": "string",
    • "nodeKey": "string",
    • "sourceNodeInstanceId": "string",
    • "sourceNodeKey": "string",
    • "instanceDataId": "string",
    • "status": 0,
    • "nodeType": 0,
    • "properties": {

      • "property1": null,
      • "property2": null

      }

    },
  • "instanceDataId": "string",
  • "instanceDataMap": {

    • "property1": null,
    • "property2": null

    },
  • "processStatus": 0,
  • "callActivityFlowModuleId": "string",
  • "callActivityRuntimeResultList": [

    • {

      • "errCode": 0,
      • "errMsg": "string",
      • "flowInstanceId": "string",
      • "status": 0,
      • "nodeExecuteResults": [

        • {

          • "errCode": 0,
          • "errMsg": "string",
          • "activeTaskInstance": {

            • "key": "string",
            • "name": "string",
            • "status": 0,
            • "subFlowInstanceIdList": [

              • "string"

              ],
            • "subElementInstanceList": [

              • {

                • "key": "string",
                • "name": "string",
                • "properties": {

                  • "property1": null,
                  • "property2": null

                  },
                • "status": 0,
                • "nodeInstanceId": "string",
                • "subFlowInstanceIdList": [

                  • null

                  ],
                • "subElementInstanceList": [

                  • null

                  ],
                • "instanceDataId": "string"

                }

              ],
            • "instanceDataId": "string",
            • "nodeInstanceId": "string",
            • "flowElementType": 0,
            • "subNodeResultList": [

              • { }

              ],
            • "createTime": "2022-03-10T12:15:50",
            • "modifyTime": "2022-03-10T12:15:50",
            • "properties": {

              • "property1": null,
              • "property2": null

              }

            },
          • "variables": {

            • "property1": null,
            • "property2": null

            }

          }

        ],
      • "extendProperties": {

        • "property1": null,
        • "property2": null

        },
      • "activeTaskInstance": {

        • "key": "string",
        • "name": "string",
        • "status": 0,
        • "subFlowInstanceIdList": [

          • "string"

          ],
        • "subElementInstanceList": [

          • {

            • "key": "string",
            • "name": "string",
            • "properties": {

              • "property1": null,
              • "property2": null

              },
            • "status": 0,
            • "nodeInstanceId": "string",
            • "subFlowInstanceIdList": [

              • "string"

              ],
            • "subElementInstanceList": [

              • { }

              ],
            • "instanceDataId": "string"

            }

          ],
        • "instanceDataId": "string",
        • "nodeInstanceId": "string",
        • "flowElementType": 0,
        • "subNodeResultList": [

          • { }

          ],
        • "createTime": "2022-03-10T12:15:50",
        • "modifyTime": "2022-03-10T12:15:50",
        • "properties": {

          • "property1": null,
          • "property2": null

          }

        },
      • "variables": {

        • "property1": null,
        • "property2": null

        }

      }

    ],
  • "extendProperties": {

    • "property1": null,
    • "property2": null

    },
  • "extendRuntimeContextList": [

    • {

      • "branchExecuteDataMap": {

        • "property1": null,
        • "property2": null

        },
      • "branchSuspendNodeInstance": {

        • "id": 0,
        • "nodeInstanceId": "string",
        • "nodeKey": "string",
        • "sourceNodeInstanceId": "string",
        • "sourceNodeKey": "string",
        • "instanceDataId": "string",
        • "status": 0,
        • "nodeType": 0,
        • "properties": {

          • "property1": null,
          • "property2": null

          }

        },
      • "currentNodeModel": {

        • "key": "string",
        • "type": 0,
        • "outgoing": [

          • "string"

          ],
        • "properties": {

          • "property1": null,
          • "property2": null

          },
        • "incoming": [

          • "string"

          ]

        },
      • "exception": {

        • "errNo": 0,
        • "errMsg": "string"

        }

      }

    ]

  }

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "errCode": 0,
• "errMsg": "success",
• "flowInstanceId": "flow_inst_001",
• "status": 1,
• "flowDeployId": "flow_deploy_001",
• "flowModuleId": "flow_module_001",
• "nodeExecuteResults": [

  • {

    • "errCode": 0,
    • "errMsg": "string",
    • "activeTaskInstance": {

      • "key": "string",
      • "name": "string",
      • "status": 0,
      • "subFlowInstanceIdList": [

        • "string"

        ],
      • "subElementInstanceList": [

        • {

          • "key": "string",
          • "name": "string",
          • "properties": {

            • "property1": null,
            • "property2": null

            },
          • "status": 0,
          • "nodeInstanceId": "string",
          • "subFlowInstanceIdList": [

            • "string"

            ],
          • "subElementInstanceList": [

            • { }

            ],
          • "instanceDataId": "string"

          }

        ],
      • "instanceDataId": "string",
      • "nodeInstanceId": "string",
      • "flowElementType": 0,
      • "subNodeResultList": [

        • {

          • "errCode": 0,
          • "errMsg": "string",
          • "flowInstanceId": "string",
          • "status": 0,
          • "nodeExecuteResults": [

            • { }

            ],
          • "extendProperties": {

            • "property1": null,
            • "property2": null

            },
          • "activeTaskInstance": { },
          • "variables": {

            • "property1": null,
            • "property2": null

            }

          }

        ],
      • "createTime": "2022-03-10T12:15:50",
      • "modifyTime": "2022-03-10T12:15:50",
      • "properties": {

        • "property1": null,
        • "property2": null

        }

      },
    • "variables": {

      • "property1": null,
      • "property2": null

      }

    }

  ],
• "extendProperties": {

  • "property1": null,
  • "property2": null

  },
• "activeTaskInstance": {

  • "key": "string",
  • "name": "string",
  • "status": 0,
  • "subFlowInstanceIdList": [

    • "string"

    ],
  • "subElementInstanceList": [

    • {

      • "key": "string",
      • "name": "string",
      • "properties": {

        • "property1": null,
        • "property2": null

        },
      • "status": 0,
      • "nodeInstanceId": "string",
      • "subFlowInstanceIdList": [

        • "string"

        ],
      • "subElementInstanceList": [

        • { }

        ],
      • "instanceDataId": "string"

      }

    ],
  • "instanceDataId": "string",
  • "nodeInstanceId": "string",
  • "flowElementType": 0,
  • "subNodeResultList": [

    • {

      • "errCode": 0,
      • "errMsg": "string",
      • "flowInstanceId": "string",
      • "status": 0,
      • "nodeExecuteResults": [

        • {

          • "errCode": 0,
          • "errMsg": "string",
          • "activeTaskInstance": { },
          • "variables": {

            • "property1": null,
            • "property2": null

            }

          }

        ],
      • "extendProperties": {

        • "property1": null,
        • "property2": null

        },
      • "activeTaskInstance": { },
      • "variables": {

        • "property1": null,
        • "property2": null

        }

      }

    ],
  • "createTime": "2022-03-10T12:15:50",
  • "modifyTime": "2022-03-10T12:15:50",
  • "properties": {

    • "property1": null,
    • "property2": null

    }

  },
• "variables": {

  • "property1": null,
  • "property2": null

  }

}

获取流程实例信息

Authorizations:

BearerAuth

path Parameters

flowInstanceId required

string 流程实例ID

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/flows/instances/{flowInstanceId}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "flowInstanceId": "flow_inst_001",
• "flowModuleId": "flow_module_001",
• "flowDeployId": "flow_deploy_001",
• "status": 1,
• "parentFlowInstanceId": "parent_inst_001",
• "tenant": "default",
• "caller": "admin",
• "operator": "admin",
• "createTime": "2022-03-10T12:15:50",
• "modifyTime": "2022-03-10T12:15:50"

}

提交任务

Authorizations:

BearerAuth

path Parameters

flowInstanceId required

string 流程实例ID

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

flowInstanceId	string 流程实例ID
nodeInstanceId	any 节点实例ID
	object or array 流程变量
tenant	any 租户
caller	any 调用者
operator	any 操作者
taskInstanceId	string
	object (RuntimeContext)
	object
callActivityFlowModuleId	string

Responses

https://preview.flexmodel.wetech.tech/api/f/flows/instances/{flowInstanceId}/commit

Request samples

• Payload

Content type

application/json

{

• "flowInstanceId": "flow_inst_001",
• "nodeInstanceId": "node_inst_001",
• "variables": {

  • "property1": null,
  • "property2": null

  },
• "tenant": "default",
• "caller": "admin",
• "operator": "admin",
• "taskInstanceId": "string",
• "runtimeContext": {

  • "parentRuntimeContext": { },
  • "flowDeployId": "string",
  • "flowModuleId": "string",
  • "tenantId": "string",
  • "caller": "string",
  • "flowElementMap": {

    • "property1": {

      • "key": "string",
      • "type": 0,
      • "outgoing": [

        • "string"

        ],
      • "properties": {

        • "property1": null,
        • "property2": null

        },
      • "incoming": [

        • "string"

        ]

      },
    • "property2": {

      • "key": "string",
      • "type": 0,
      • "outgoing": [

        • "string"

        ],
      • "properties": {

        • "property1": null,
        • "property2": null

        },
      • "incoming": [

        • "string"

        ]

      }

    },
  • "flowInstanceId": "string",
  • "flowInstanceStatus": 0,
  • "suspendNodeInstance": {

    • "id": 0,
    • "nodeInstanceId": "string",
    • "nodeKey": "string",
    • "sourceNodeInstanceId": "string",
    • "sourceNodeKey": "string",
    • "instanceDataId": "string",
    • "status": 0,
    • "nodeType": 0,
    • "properties": {

      • "property1": null,
      • "property2": null

      }

    },
  • "nodeInstanceList": [

    • {

      • "id": 0,
      • "nodeInstanceId": "string",
      • "nodeKey": "string",
      • "sourceNodeInstanceId": "string",
      • "sourceNodeKey": "string",
      • "instanceDataId": "string",
      • "status": 0,
      • "nodeType": 0,
      • "properties": {

        • "property1": null,
        • "property2": null

        }

      }

    ],
  • "suspendNodeInstanceStack": [

    • "string"

    ],
  • "currentNodeModel": {

    • "key": "string",
    • "type": 0,
    • "outgoing": [

      • "string"

      ],
    • "properties": {

      • "property1": null,
      • "property2": null

      },
    • "incoming": [

      • "string"

      ]

    },
  • "currentNodeInstance": {

    • "id": 0,
    • "nodeInstanceId": "string",
    • "nodeKey": "string",
    • "sourceNodeInstanceId": "string",
    • "sourceNodeKey": "string",
    • "instanceDataId": "string",
    • "status": 0,
    • "nodeType": 0,
    • "properties": {

      • "property1": null,
      • "property2": null

      }

    },
  • "instanceDataId": "string",
  • "instanceDataMap": {

    • "property1": null,
    • "property2": null

    },
  • "processStatus": 0,
  • "callActivityFlowModuleId": "string",
  • "callActivityRuntimeResultList": [

    • {

      • "errCode": 0,
      • "errMsg": "string",
      • "flowInstanceId": "string",
      • "status": 0,
      • "nodeExecuteResults": [

        • {

          • "errCode": 0,
          • "errMsg": "string",
          • "activeTaskInstance": {

            • "key": "string",
            • "name": "string",
            • "status": 0,
            • "subFlowInstanceIdList": [

              • "string"

              ],
            • "subElementInstanceList": [

              • {

                • "key": "string",
                • "name": "string",
                • "properties": {

                  • "property1": null,
                  • "property2": null

                  },
                • "status": 0,
                • "nodeInstanceId": "string",
                • "subFlowInstanceIdList": [

                  • null

                  ],
                • "subElementInstanceList": [

                  • null

                  ],
                • "instanceDataId": "string"

                }

              ],
            • "instanceDataId": "string",
            • "nodeInstanceId": "string",
            • "flowElementType": 0,
            • "subNodeResultList": [

              • { }

              ],
            • "createTime": "2022-03-10T12:15:50",
            • "modifyTime": "2022-03-10T12:15:50",
            • "properties": {

              • "property1": null,
              • "property2": null

              }

            },
          • "variables": {

            • "property1": null,
            • "property2": null

            }

          }

        ],
      • "extendProperties": {

        • "property1": null,
        • "property2": null

        },
      • "activeTaskInstance": {

        • "key": "string",
        • "name": "string",
        • "status": 0,
        • "subFlowInstanceIdList": [

          • "string"

          ],
        • "subElementInstanceList": [

          • {

            • "key": "string",
            • "name": "string",
            • "properties": {

              • "property1": null,
              • "property2": null

              },
            • "status": 0,
            • "nodeInstanceId": "string",
            • "subFlowInstanceIdList": [

              • "string"

              ],
            • "subElementInstanceList": [

              • { }

              ],
            • "instanceDataId": "string"

            }

          ],
        • "instanceDataId": "string",
        • "nodeInstanceId": "string",
        • "flowElementType": 0,
        • "subNodeResultList": [

          • { }

          ],
        • "createTime": "2022-03-10T12:15:50",
        • "modifyTime": "2022-03-10T12:15:50",
        • "properties": {

          • "property1": null,
          • "property2": null

          }

        },
      • "variables": {

        • "property1": null,
        • "property2": null

        }

      }

    ],
  • "extendProperties": {

    • "property1": null,
    • "property2": null

    },
  • "extendRuntimeContextList": [

    • {

      • "branchExecuteDataMap": {

        • "property1": null,
        • "property2": null

        },
      • "branchSuspendNodeInstance": {

        • "id": 0,
        • "nodeInstanceId": "string",
        • "nodeKey": "string",
        • "sourceNodeInstanceId": "string",
        • "sourceNodeKey": "string",
        • "instanceDataId": "string",
        • "status": 0,
        • "nodeType": 0,
        • "properties": {

          • "property1": null,
          • "property2": null

          }

        },
      • "currentNodeModel": {

        • "key": "string",
        • "type": 0,
        • "outgoing": [

          • "string"

          ],
        • "properties": {

          • "property1": null,
          • "property2": null

          },
        • "incoming": [

          • "string"

          ]

        },
      • "exception": {

        • "errNo": 0,
        • "errMsg": "string"

        }

      }

    ]

  },
• "extendProperties": {

  • "property1": null,
  • "property2": null

  },
• "callActivityFlowModuleId": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "errCode": 0,
• "errMsg": "success",
• "flowInstanceId": "flow_inst_001",
• "status": 1,
• "nodeExecuteResults": [

  • {

    • "errCode": 0,
    • "errMsg": "string",
    • "activeTaskInstance": {

      • "key": "string",
      • "name": "string",
      • "status": 0,
      • "subFlowInstanceIdList": [

        • "string"

        ],
      • "subElementInstanceList": [

        • {

          • "key": "string",
          • "name": "string",
          • "properties": {

            • "property1": null,
            • "property2": null

            },
          • "status": 0,
          • "nodeInstanceId": "string",
          • "subFlowInstanceIdList": [

            • "string"

            ],
          • "subElementInstanceList": [

            • { }

            ],
          • "instanceDataId": "string"

          }

        ],
      • "instanceDataId": "string",
      • "nodeInstanceId": "string",
      • "flowElementType": 0,
      • "subNodeResultList": [

        • {

          • "errCode": 0,
          • "errMsg": "string",
          • "flowInstanceId": "string",
          • "status": 0,
          • "nodeExecuteResults": [

            • { }

            ],
          • "extendProperties": {

            • "property1": null,
            • "property2": null

            },
          • "activeTaskInstance": { },
          • "variables": {

            • "property1": null,
            • "property2": null

            }

          }

        ],
      • "createTime": "2022-03-10T12:15:50",
      • "modifyTime": "2022-03-10T12:15:50",
      • "properties": {

        • "property1": null,
        • "property2": null

        }

      },
    • "variables": {

      • "property1": null,
      • "property2": null

      }

    }

  ],
• "extendProperties": {

  • "property1": null,
  • "property2": null

  },
• "activeTaskInstance": {

  • "key": "string",
  • "name": "string",
  • "status": 0,
  • "subFlowInstanceIdList": [

    • "string"

    ],
  • "subElementInstanceList": [

    • {

      • "key": "string",
      • "name": "string",
      • "properties": {

        • "property1": null,
        • "property2": null

        },
      • "status": 0,
      • "nodeInstanceId": "string",
      • "subFlowInstanceIdList": [

        • "string"

        ],
      • "subElementInstanceList": [

        • { }

        ],
      • "instanceDataId": "string"

      }

    ],
  • "instanceDataId": "string",
  • "nodeInstanceId": "string",
  • "flowElementType": 0,
  • "subNodeResultList": [

    • {

      • "errCode": 0,
      • "errMsg": "string",
      • "flowInstanceId": "string",
      • "status": 0,
      • "nodeExecuteResults": [

        • {

          • "errCode": 0,
          • "errMsg": "string",
          • "activeTaskInstance": { },
          • "variables": {

            • "property1": null,
            • "property2": null

            }

          }

        ],
      • "extendProperties": {

        • "property1": null,
        • "property2": null

        },
      • "activeTaskInstance": { },
      • "variables": {

        • "property1": null,
        • "property2": null

        }

      }

    ],
  • "createTime": "2022-03-10T12:15:50",
  • "modifyTime": "2022-03-10T12:15:50",
  • "properties": {

    • "property1": null,
    • "property2": null

    }

  },
• "variables": {

  • "property1": null,
  • "property2": null

  }

}

获取流程实例历史元素列表

获取指定流程实例的历史元素列表，主要用于显示流程快照视图。包含流程中已执行的所有节点信息。

Authorizations:

BearerAuth

path Parameters

flowInstanceId required

string Example: flow_inst_001 流程实例ID

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/flows/instances/{flowInstanceId}/elements

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "Key": "start_event_001",
  • "name": "开始事件",
  • "status": 2,
  • "properties": {

    • "property1": null,
    • "property2": null

    },
  • "nodeInstanceId": "node_inst_001",
  • "subFlowInstanceIdList": [

    • "string"

    ],
  • "subElementInstanceList": [

    • {

      • "key": "string",
      • "name": "string",
      • "properties": {

        • "property1": null,
        • "property2": null

        },
      • "status": 0,
      • "nodeInstanceId": "string",
      • "subFlowInstanceIdList": [

        • "string"

        ],
      • "subElementInstanceList": [

        • { }

        ],
      • "instanceDataId": "string"

      }

    ],
  • "instanceDataId": "data_001",
  • "key": "string"

  }

]

回滚任务

Authorizations:

BearerAuth

path Parameters

flowInstanceId required

string 流程实例ID

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

flowInstanceId	string 流程实例ID
nodeInstanceId	any 节点实例ID
tenant	any 租户
caller	any 调用者
operator	any 操作者
taskInstanceId	string
	object (RuntimeContext)
	object

Responses

https://preview.flexmodel.wetech.tech/api/f/flows/instances/{flowInstanceId}/rollback

Request samples

• Payload

Content type

application/json

{

• "flowInstanceId": "flow_inst_001",
• "nodeInstanceId": "node_inst_001",
• "tenant": "default",
• "caller": "admin",
• "operator": "admin",
• "taskInstanceId": "string",
• "runtimeContext": {

  • "parentRuntimeContext": { },
  • "flowDeployId": "string",
  • "flowModuleId": "string",
  • "tenantId": "string",
  • "caller": "string",
  • "flowElementMap": {

    • "property1": {

      • "key": "string",
      • "type": 0,
      • "outgoing": [

        • "string"

        ],
      • "properties": {

        • "property1": null,
        • "property2": null

        },
      • "incoming": [

        • "string"

        ]

      },
    • "property2": {

      • "key": "string",
      • "type": 0,
      • "outgoing": [

        • "string"

        ],
      • "properties": {

        • "property1": null,
        • "property2": null

        },
      • "incoming": [

        • "string"

        ]

      }

    },
  • "flowInstanceId": "string",
  • "flowInstanceStatus": 0,
  • "suspendNodeInstance": {

    • "id": 0,
    • "nodeInstanceId": "string",
    • "nodeKey": "string",
    • "sourceNodeInstanceId": "string",
    • "sourceNodeKey": "string",
    • "instanceDataId": "string",
    • "status": 0,
    • "nodeType": 0,
    • "properties": {

      • "property1": null,
      • "property2": null

      }

    },
  • "nodeInstanceList": [

    • {

      • "id": 0,
      • "nodeInstanceId": "string",
      • "nodeKey": "string",
      • "sourceNodeInstanceId": "string",
      • "sourceNodeKey": "string",
      • "instanceDataId": "string",
      • "status": 0,
      • "nodeType": 0,
      • "properties": {

        • "property1": null,
        • "property2": null

        }

      }

    ],
  • "suspendNodeInstanceStack": [

    • "string"

    ],
  • "currentNodeModel": {

    • "key": "string",
    • "type": 0,
    • "outgoing": [

      • "string"

      ],
    • "properties": {

      • "property1": null,
      • "property2": null

      },
    • "incoming": [

      • "string"

      ]

    },
  • "currentNodeInstance": {

    • "id": 0,
    • "nodeInstanceId": "string",
    • "nodeKey": "string",
    • "sourceNodeInstanceId": "string",
    • "sourceNodeKey": "string",
    • "instanceDataId": "string",
    • "status": 0,
    • "nodeType": 0,
    • "properties": {

      • "property1": null,
      • "property2": null

      }

    },
  • "instanceDataId": "string",
  • "instanceDataMap": {

    • "property1": null,
    • "property2": null

    },
  • "processStatus": 0,
  • "callActivityFlowModuleId": "string",
  • "callActivityRuntimeResultList": [

    • {

      • "errCode": 0,
      • "errMsg": "string",
      • "flowInstanceId": "string",
      • "status": 0,
      • "nodeExecuteResults": [

        • {

          • "errCode": 0,
          • "errMsg": "string",
          • "activeTaskInstance": {

            • "key": "string",
            • "name": "string",
            • "status": 0,
            • "subFlowInstanceIdList": [

              • "string"

              ],
            • "subElementInstanceList": [

              • {

                • "key": "string",
                • "name": "string",
                • "properties": {

                  • "property1": null,
                  • "property2": null

                  },
                • "status": 0,
                • "nodeInstanceId": "string",
                • "subFlowInstanceIdList": [

                  • null

                  ],
                • "subElementInstanceList": [

                  • null

                  ],
                • "instanceDataId": "string"

                }

              ],
            • "instanceDataId": "string",
            • "nodeInstanceId": "string",
            • "flowElementType": 0,
            • "subNodeResultList": [

              • { }

              ],
            • "createTime": "2022-03-10T12:15:50",
            • "modifyTime": "2022-03-10T12:15:50",
            • "properties": {

              • "property1": null,
              • "property2": null

              }

            },
          • "variables": {

            • "property1": null,
            • "property2": null

            }

          }

        ],
      • "extendProperties": {

        • "property1": null,
        • "property2": null

        },
      • "activeTaskInstance": {

        • "key": "string",
        • "name": "string",
        • "status": 0,
        • "subFlowInstanceIdList": [

          • "string"

          ],
        • "subElementInstanceList": [

          • {

            • "key": "string",
            • "name": "string",
            • "properties": {

              • "property1": null,
              • "property2": null

              },
            • "status": 0,
            • "nodeInstanceId": "string",
            • "subFlowInstanceIdList": [

              • "string"

              ],
            • "subElementInstanceList": [

              • { }

              ],
            • "instanceDataId": "string"

            }

          ],
        • "instanceDataId": "string",
        • "nodeInstanceId": "string",
        • "flowElementType": 0,
        • "subNodeResultList": [

          • { }

          ],
        • "createTime": "2022-03-10T12:15:50",
        • "modifyTime": "2022-03-10T12:15:50",
        • "properties": {

          • "property1": null,
          • "property2": null

          }

        },
      • "variables": {

        • "property1": null,
        • "property2": null

        }

      }

    ],
  • "extendProperties": {

    • "property1": null,
    • "property2": null

    },
  • "extendRuntimeContextList": [

    • {

      • "branchExecuteDataMap": {

        • "property1": null,
        • "property2": null

        },
      • "branchSuspendNodeInstance": {

        • "id": 0,
        • "nodeInstanceId": "string",
        • "nodeKey": "string",
        • "sourceNodeInstanceId": "string",
        • "sourceNodeKey": "string",
        • "instanceDataId": "string",
        • "status": 0,
        • "nodeType": 0,
        • "properties": {

          • "property1": null,
          • "property2": null

          }

        },
      • "currentNodeModel": {

        • "key": "string",
        • "type": 0,
        • "outgoing": [

          • "string"

          ],
        • "properties": {

          • "property1": null,
          • "property2": null

          },
        • "incoming": [

          • "string"

          ]

        },
      • "exception": {

        • "errNo": 0,
        • "errMsg": "string"

        }

      }

    ]

  },
• "extendProperties": {

  • "property1": null,
  • "property2": null

  }

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "errCode": 0,
• "errMsg": "success",
• "flowInstanceId": "flow_inst_001",
• "status": 1,
• "nodeExecuteResults": [

  • {

    • "errCode": 0,
    • "errMsg": "string",
    • "activeTaskInstance": {

      • "key": "string",
      • "name": "string",
      • "status": 0,
      • "subFlowInstanceIdList": [

        • "string"

        ],
      • "subElementInstanceList": [

        • {

          • "key": "string",
          • "name": "string",
          • "properties": {

            • "property1": null,
            • "property2": null

            },
          • "status": 0,
          • "nodeInstanceId": "string",
          • "subFlowInstanceIdList": [

            • "string"

            ],
          • "subElementInstanceList": [

            • { }

            ],
          • "instanceDataId": "string"

          }

        ],
      • "instanceDataId": "string",
      • "nodeInstanceId": "string",
      • "flowElementType": 0,
      • "subNodeResultList": [

        • {

          • "errCode": 0,
          • "errMsg": "string",
          • "flowInstanceId": "string",
          • "status": 0,
          • "nodeExecuteResults": [

            • { }

            ],
          • "extendProperties": {

            • "property1": null,
            • "property2": null

            },
          • "activeTaskInstance": { },
          • "variables": {

            • "property1": null,
            • "property2": null

            }

          }

        ],
      • "createTime": "2022-03-10T12:15:50",
      • "modifyTime": "2022-03-10T12:15:50",
      • "properties": {

        • "property1": null,
        • "property2": null

        }

      },
    • "variables": {

      • "property1": null,
      • "property2": null

      }

    }

  ],
• "extendProperties": {

  • "property1": null,
  • "property2": null

  },
• "activeTaskInstance": {

  • "key": "string",
  • "name": "string",
  • "status": 0,
  • "subFlowInstanceIdList": [

    • "string"

    ],
  • "subElementInstanceList": [

    • {

      • "key": "string",
      • "name": "string",
      • "properties": {

        • "property1": null,
        • "property2": null

        },
      • "status": 0,
      • "nodeInstanceId": "string",
      • "subFlowInstanceIdList": [

        • "string"

        ],
      • "subElementInstanceList": [

        • { }

        ],
      • "instanceDataId": "string"

      }

    ],
  • "instanceDataId": "string",
  • "nodeInstanceId": "string",
  • "flowElementType": 0,
  • "subNodeResultList": [

    • {

      • "errCode": 0,
      • "errMsg": "string",
      • "flowInstanceId": "string",
      • "status": 0,
      • "nodeExecuteResults": [

        • {

          • "errCode": 0,
          • "errMsg": "string",
          • "activeTaskInstance": { },
          • "variables": {

            • "property1": null,
            • "property2": null

            }

          }

        ],
      • "extendProperties": {

        • "property1": null,
        • "property2": null

        },
      • "activeTaskInstance": { },
      • "variables": {

        • "property1": null,
        • "property2": null

        }

      }

    ],
  • "createTime": "2022-03-10T12:15:50",
  • "modifyTime": "2022-03-10T12:15:50",
  • "properties": {

    • "property1": null,
    • "property2": null

    }

  },
• "variables": {

  • "property1": null,
  • "property2": null

  }

}

终止流程实例

Authorizations:

BearerAuth

path Parameters

flowInstanceId required

string 流程实例ID

query Parameters

effectiveForSubFlowInstance

boolean Default: true 是否对子流程实例生效

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/flows/instances/{flowInstanceId}/terminate

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "errCode": 0,
• "errMsg": "success",
• "flowInstanceId": "flow_inst_001",
• "status": 1,
• "nodeExecuteResults": [

  • {

    • "errCode": 0,
    • "errMsg": "string",
    • "activeTaskInstance": {

      • "key": "string",
      • "name": "string",
      • "status": 0,
      • "subFlowInstanceIdList": [

        • "string"

        ],
      • "subElementInstanceList": [

        • {

          • "key": "string",
          • "name": "string",
          • "properties": {

            • "property1": null,
            • "property2": null

            },
          • "status": 0,
          • "nodeInstanceId": "string",
          • "subFlowInstanceIdList": [

            • "string"

            ],
          • "subElementInstanceList": [

            • { }

            ],
          • "instanceDataId": "string"

          }

        ],
      • "instanceDataId": "string",
      • "nodeInstanceId": "string",
      • "flowElementType": 0,
      • "subNodeResultList": [

        • {

          • "errCode": 0,
          • "errMsg": "string",
          • "flowInstanceId": "string",
          • "status": 0,
          • "nodeExecuteResults": [

            • { }

            ],
          • "extendProperties": {

            • "property1": null,
            • "property2": null

            },
          • "activeTaskInstance": { },
          • "variables": {

            • "property1": null,
            • "property2": null

            }

          }

        ],
      • "createTime": "2022-03-10T12:15:50",
      • "modifyTime": "2022-03-10T12:15:50",
      • "properties": {

        • "property1": null,
        • "property2": null

        }

      },
    • "variables": {

      • "property1": null,
      • "property2": null

      }

    }

  ],
• "extendProperties": {

  • "property1": null,
  • "property2": null

  },
• "activeTaskInstance": {

  • "key": "string",
  • "name": "string",
  • "status": 0,
  • "subFlowInstanceIdList": [

    • "string"

    ],
  • "subElementInstanceList": [

    • {

      • "key": "string",
      • "name": "string",
      • "properties": {

        • "property1": null,
        • "property2": null

        },
      • "status": 0,
      • "nodeInstanceId": "string",
      • "subFlowInstanceIdList": [

        • "string"

        ],
      • "subElementInstanceList": [

        • { }

        ],
      • "instanceDataId": "string"

      }

    ],
  • "instanceDataId": "string",
  • "nodeInstanceId": "string",
  • "flowElementType": 0,
  • "subNodeResultList": [

    • {

      • "errCode": 0,
      • "errMsg": "string",
      • "flowInstanceId": "string",
      • "status": 0,
      • "nodeExecuteResults": [

        • {

          • "errCode": 0,
          • "errMsg": "string",
          • "activeTaskInstance": { },
          • "variables": {

            • "property1": null,
            • "property2": null

            }

          }

        ],
      • "extendProperties": {

        • "property1": null,
        • "property2": null

        },
      • "activeTaskInstance": { },
      • "variables": {

        • "property1": null,
        • "property2": null

        }

      }

    ],
  • "createTime": "2022-03-10T12:15:50",
  • "modifyTime": "2022-03-10T12:15:50",
  • "properties": {

    • "property1": null,
    • "property2": null

    }

  },
• "variables": {

  • "property1": null,
  • "property2": null

  }

}

获取流程实例历史用户任务列表

获取指定流程实例的历史用户任务列表，按处理时间倒序排列。包含活跃和已完成的任务，不包含已禁用的任务。

Authorizations:

BearerAuth

path Parameters

flowInstanceId required

string Example: flow_inst_001 流程实例ID

query Parameters

effectiveForSubFlowInstance

boolean Default: true Example: effectiveForSubFlowInstance=true 是否对子流程实例生效

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/flows/instances/{flowInstanceId}/user-tasks

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "nodeInstanceId": "node_inst_001",
  • "Key": "user_task_001",
  • "modelName": "用户审批任务",
  • "status": 2,
  • "flowElementType": 1,
  • "properties": {

    • "property1": null,
    • "property2": null

    },
  • "subNodeResultList": [

    • {

      • "errCode": 0,
      • "errMsg": "string",
      • "flowInstanceId": "string",
      • "status": 0,
      • "nodeExecuteResults": [

        • {

          • "errCode": 0,
          • "errMsg": "string",
          • "activeTaskInstance": {

            • "key": "string",
            • "name": "string",
            • "status": 0,
            • "subFlowInstanceIdList": [

              • "string"

              ],
            • "subElementInstanceList": [

              • {

                • "key": "string",
                • "name": "string",
                • "properties": {

                  • "property1": null,
                  • "property2": null

                  },
                • "status": 0,
                • "nodeInstanceId": "string",
                • "subFlowInstanceIdList": [

                  • null

                  ],
                • "subElementInstanceList": [

                  • null

                  ],
                • "instanceDataId": "string"

                }

              ],
            • "instanceDataId": "string",
            • "nodeInstanceId": "string",
            • "flowElementType": 0,
            • "subNodeResultList": [

              • { }

              ],
            • "createTime": "2022-03-10T12:15:50",
            • "modifyTime": "2022-03-10T12:15:50",
            • "properties": {

              • "property1": null,
              • "property2": null

              }

            },
          • "variables": {

            • "property1": null,
            • "property2": null

            }

          }

        ],
      • "extendProperties": {

        • "property1": null,
        • "property2": null

        },
      • "activeTaskInstance": {

        • "key": "string",
        • "name": "string",
        • "status": 0,
        • "subFlowInstanceIdList": [

          • "string"

          ],
        • "subElementInstanceList": [

          • {

            • "key": "string",
            • "name": "string",
            • "properties": {

              • "property1": null,
              • "property2": null

              },
            • "status": 0,
            • "nodeInstanceId": "string",
            • "subFlowInstanceIdList": [

              • "string"

              ],
            • "subElementInstanceList": [

              • { }

              ],
            • "instanceDataId": "string"

            }

          ],
        • "instanceDataId": "string",
        • "nodeInstanceId": "string",
        • "flowElementType": 0,
        • "subNodeResultList": [

          • { }

          ],
        • "createTime": "2022-03-10T12:15:50",
        • "modifyTime": "2022-03-10T12:15:50",
        • "properties": {

          • "property1": null,
          • "property2": null

          }

        },
      • "variables": {

        • "property1": null,
        • "property2": null

        }

      }

    ],
  • "subFlowInstanceIdList": [

    • "string"

    ],
  • "subElementInstanceList": [

    • {

      • "key": "string",
      • "name": "string",
      • "properties": {

        • "property1": null,
        • "property2": null

        },
      • "status": 0,
      • "nodeInstanceId": "string",
      • "subFlowInstanceIdList": [

        • "string"

        ],
      • "subElementInstanceList": [

        • { }

        ],
      • "instanceDataId": "string"

      }

    ],
  • "instanceDataId": "data_001",
  • "createTime": "2022-03-10T12:15:50",
  • "modifyTime": "2022-03-10T12:15:50",
  • "key": "string",
  • "name": "string"

  }

]

更新流程

Authorizations:

BearerAuth

path Parameters

flowModuleId required

string 流程模块ID

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

flowModuleId	string 流程模块ID
tenant	string 租户
caller	string 调用者
operator	string 操作者

Responses

https://preview.flexmodel.wetech.tech/api/f/flows/{flowModuleId}

Request samples

• Payload

Content type

application/json

{

• "flowModuleId": "flow_module_001",
• "tenant": "default",
• "caller": "admin",
• "operator": "admin"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "errCode": 0,
• "errMsg": "success"

}

获取流程模块信息

Authorizations:

BearerAuth

path Parameters

flowModuleId required

string 流程模块ID

query Parameters

flowDeployId

string 流程部署ID

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/flows/{flowModuleId}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "errCode": 0,
• "errMsg": "success",
• "flowModuleId": "flow_module_001",
• "flowDeployId": "flow_deploy_001",
• "flowName": "string",
• "flowKey": "string",
• "flowModel": "string",
• "status": 0,
• "remark": "string",
• "tenant": "string",
• "caller": "string",
• "operator": "string",
• "modifyTime": "2022-03-10T12:15:50"

}

Delete Flow

Authorizations:

BearerAuth

path Parameters

flowModuleId required

string 流程模块ID

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/flows/{flowModuleId}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

部署流程

Authorizations:

BearerAuth

path Parameters

flowModuleId required

string 流程模块ID

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

flowModuleId	string 流程模块ID
tenant	string 租户
caller	string 调用者
operator	string 操作者

Responses

https://preview.flexmodel.wetech.tech/api/f/flows/{flowModuleId}/deploy

Request samples

• Payload

Content type

application/json

{

• "flowModuleId": "flow_module_001",
• "tenant": "default",
• "caller": "admin",
• "operator": "admin"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "errCode": 0,
• "errMsg": "success",
• "flowDeployId": "flow_deploy_001",
• "flowModuleId": "flow_module_001"

}

【Flexmodel】模型

模型管理

获取模型列表

Authorizations:

BearerAuth

path Parameters

datasourceName required

string 数据源名称

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models

Response samples

• 200
• 400
• 500

Content type

application/json

Example

实体枚举本地查询实体

[

• {

  • "type": "entity",
  • "name": "Student",
  • "fields": [

    • {

      • "name": "id",
      • "type": "Long",
      • "identity": true,
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "studentName",
      • "type": "String",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true,
      • "length": 255

      },
    • {

      • "name": "gender",
      • "type": "EnumRef",
      • "from": "UserGender",
      • "multiple": false,
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "interest",
      • "type": "EnumRef",
      • "from": "user_interest",
      • "multiple": true,
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "age",
      • "type": "Int",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "classId",
      • "type": "Long",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true

      },
    • {

      • "name": "studentDetail",
      • "type": "Relation",
      • "modelName": "Student",
      • "unique": false,
      • "nullable": true,
      • "multiple": false,
      • "from": "StudentDetail",
      • "localField": "id",
      • "foreignField": "studentId",
      • "cascadeDelete": true

      }

    ],
  • "indexes": [

    • {

      • "modelName": "Student",
      • "name": "IDX_studentName",
      • "fields": [

        • {

          • "fieldName": "studentName",
          • "direction": "ASC"

          }

        ],
      • "unique": false

      }

    ]

  }

]

创建模型

Authorizations:

BearerAuth

path Parameters

datasourceName required

string 数据源名称

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

Any of

name	string 名称
comment	string 注释
elements	Array of strings 元素列表
	object 用户自定义扩展属性
idl	string
type	string

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models

Request samples

• Payload

Content type

application/json

Example

实体枚举本地查询实体

{

• "type": "entity",
• "name": "Student",
• "fields": [

  • {

    • "name": "id",
    • "type": "Long",
    • "identity": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentName",
    • "type": "String",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "length": 255

    },
  • {

    • "name": "gender",
    • "type": "EnumRef",
    • "from": "UserGender",
    • "multiple": false,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "interest",
    • "type": "EnumRef",
    • "from": "user_interest",
    • "multiple": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "age",
    • "type": "Int",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "classId",
    • "type": "Long",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentDetail",
    • "type": "Relation",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "multiple": false,
    • "from": "StudentDetail",
    • "localField": "id",
    • "foreignField": "studentId",
    • "cascadeDelete": true

    }

  ],
• "indexes": [

  • {

    • "modelName": "Student",
    • "name": "IDX_studentName",
    • "fields": [

      • {

        • "fieldName": "studentName",
        • "direction": "ASC"

        }

      ],
    • "unique": false

    }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

Example

实体枚举本地查询实体

{

• "type": "entity",
• "name": "Student",
• "fields": [

  • {

    • "name": "id",
    • "type": "Long",
    • "identity": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentName",
    • "type": "String",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "length": 255

    },
  • {

    • "name": "gender",
    • "type": "EnumRef",
    • "from": "UserGender",
    • "multiple": false,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "interest",
    • "type": "EnumRef",
    • "from": "user_interest",
    • "multiple": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "age",
    • "type": "Int",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "classId",
    • "type": "Long",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentDetail",
    • "type": "Relation",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "multiple": false,
    • "from": "StudentDetail",
    • "localField": "id",
    • "foreignField": "studentId",
    • "cascadeDelete": true

    }

  ],
• "indexes": [

  • {

    • "modelName": "Student",
    • "name": "IDX_studentName",
    • "fields": [

      • {

        • "fieldName": "studentName",
        • "direction": "ASC"

        }

      ],
    • "unique": false

    }

  ]

}

Execute Idl

Authorizations:

BearerAuth

path Parameters

datasourceName required

string 数据源名称

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

idl

string

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/idl/execute

Request samples

• Payload

Content type

application/json

{

• "idl": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "name": "string",
  • "type": "string",
  • "idl": "string"

  }

]

更新模型

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

Any of

name	string 名称
comment	string 注释
elements	Array of strings 元素列表
	object 用户自定义扩展属性
idl	string
type	string

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}

Request samples

• Payload

Content type

application/json

Example

实体枚举本地查询实体

{

• "type": "entity",
• "name": "Student",
• "fields": [

  • {

    • "name": "id",
    • "type": "Long",
    • "identity": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentName",
    • "type": "String",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "length": 255

    },
  • {

    • "name": "gender",
    • "type": "EnumRef",
    • "from": "UserGender",
    • "multiple": false,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "interest",
    • "type": "EnumRef",
    • "from": "user_interest",
    • "multiple": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "age",
    • "type": "Int",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "classId",
    • "type": "Long",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentDetail",
    • "type": "Relation",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "multiple": false,
    • "from": "StudentDetail",
    • "localField": "id",
    • "foreignField": "studentId",
    • "cascadeDelete": true

    }

  ],
• "indexes": [

  • {

    • "modelName": "Student",
    • "name": "IDX_studentName",
    • "fields": [

      • {

        • "fieldName": "studentName",
        • "direction": "ASC"

        }

      ],
    • "unique": false

    }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

Example

实体枚举本地查询实体

{

• "type": "entity",
• "name": "Student",
• "fields": [

  • {

    • "name": "id",
    • "type": "Long",
    • "identity": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentName",
    • "type": "String",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "length": 255

    },
  • {

    • "name": "gender",
    • "type": "EnumRef",
    • "from": "UserGender",
    • "multiple": false,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "interest",
    • "type": "EnumRef",
    • "from": "user_interest",
    • "multiple": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "age",
    • "type": "Int",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "classId",
    • "type": "Long",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentDetail",
    • "type": "Relation",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "multiple": false,
    • "from": "StudentDetail",
    • "localField": "id",
    • "foreignField": "studentId",
    • "cascadeDelete": true

    }

  ],
• "indexes": [

  • {

    • "modelName": "Student",
    • "name": "IDX_studentName",
    • "fields": [

      • {

        • "fieldName": "studentName",
        • "direction": "ASC"

        }

      ],
    • "unique": false

    }

  ]

}

获取单个模型

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 数据源名称
modelName required	string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}

Response samples

• 200
• 400
• 500

Content type

application/json

Example

实体枚举本地查询实体

{

• "type": "entity",
• "name": "Student",
• "fields": [

  • {

    • "name": "id",
    • "type": "Long",
    • "identity": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentName",
    • "type": "String",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "length": 255

    },
  • {

    • "name": "gender",
    • "type": "EnumRef",
    • "from": "UserGender",
    • "multiple": false,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "interest",
    • "type": "EnumRef",
    • "from": "user_interest",
    • "multiple": true,
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "age",
    • "type": "Int",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "classId",
    • "type": "Long",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true

    },
  • {

    • "name": "studentDetail",
    • "type": "Relation",
    • "modelName": "Student",
    • "unique": false,
    • "nullable": true,
    • "multiple": false,
    • "from": "StudentDetail",
    • "localField": "id",
    • "foreignField": "studentId",
    • "cascadeDelete": true

    }

  ],
• "indexes": [

  • {

    • "modelName": "Student",
    • "name": "IDX_studentName",
    • "fields": [

      • {

        • "fieldName": "studentName",
        • "direction": "ASC"

        }

      ],
    • "unique": false

    }

  ]

}

删除模型

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

创建字段

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

name	string 名称
type	string 类型
comment	string 注释
unique	boolean 是否唯一
nullable	boolean 可为空
	object (DefaultValue) 默认值
	object 用户自定义扩展属性
modelName	string
identity	boolean
concreteType	string

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}/fields

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "string",
• "comment": "string",
• "unique": true,
• "nullable": true,
• "defaultValue": {

  • "type": "string",
  • "value": null,
  • "name": "string",
  • "fixed": true,
  • "generated": true

  },
• "additionalProperties": {

  • "property1": null,
  • "property2": null

  },
• "modelName": "string",
• "identity": true,
• "concreteType": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "type": "string",
• "comment": "string",
• "unique": true,
• "nullable": true,
• "defaultValue": {

  • "type": "string",
  • "value": null,
  • "name": "string",
  • "fixed": true,
  • "generated": true

  },
• "additionalProperties": {

  • "property1": null,
  • "property2": null

  },
• "modelName": "string",
• "identity": true,
• "concreteType": "string"

}

更新字段

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称
fieldName required	string 字段名称

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

name	string 名称
type	string 类型
comment	string 注释
unique	boolean 是否唯一
nullable	boolean 可为空
	object (DefaultValue) 默认值
	object 用户自定义扩展属性
modelName	string
identity	boolean
concreteType	string

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}/fields/{fieldName}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "type": "string",
• "comment": "string",
• "unique": true,
• "nullable": true,
• "defaultValue": {

  • "type": "string",
  • "value": null,
  • "name": "string",
  • "fixed": true,
  • "generated": true

  },
• "additionalProperties": {

  • "property1": null,
  • "property2": null

  },
• "modelName": "string",
• "identity": true,
• "concreteType": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "type": "string",
• "comment": "string",
• "unique": true,
• "nullable": true,
• "defaultValue": {

  • "type": "string",
  • "value": null,
  • "name": "string",
  • "fixed": true,
  • "generated": true

  },
• "additionalProperties": {

  • "property1": null,
  • "property2": null

  },
• "modelName": "string",
• "identity": true,
• "concreteType": "string"

}

删除字段

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称
fieldName required	string 字段名称

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}/fields/{fieldName}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

创建索引

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

name	string 名称
	Array of objects (Field) 字段列表
unique	boolean 是否唯一
modelName	string

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}/indexes

Request samples

• Payload

Content type

application/json

No sample

Response samples

• 200
• 400
• 500

Content type

application/json

No sample

更新索引

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称
indexName required	string 索引名称

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

name	string 名称
	Array of objects (Field) 字段列表
unique	boolean 是否唯一
modelName	string

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}/indexes/{indexName}

Request samples

• Payload

Content type

application/json

No sample

Response samples

• 200
• 400
• 500

Content type

application/json

No sample

删除索引

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 数据源名称
modelName required	string 模型名称
indexName required	string 索引名称

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}/indexes/{indexName}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

【Flexmodel】生成器

生成器管理

Get Templates

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/codegen/templates

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "name": "string",
  • "variables": {

    • "property1": null,
    • "property2": null

    }

  }

]

Generate

Authorizations:

BearerAuth

path Parameters

template required

string

query Parameters

datasource	string
variables	string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/codegen/{template}.zip

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

【Flexmodel】系统

系统信息

获取系统配置

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/global/profile

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "env": null,
• "properties": null,
• "application": null,
• "settings": null

}

【Flexmodel】系统监控

系统监控相关接口，包括JVM、CPU、内存、线程、磁盘（含I/O）、网络等监控信息

获取所有监控指标

获取JVM、CPU、内存、线程、磁盘、网络等所有监控信息，提供系统完整状态

Authorizations:

BearerAuthBearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/metrics/all

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "jvm": {

  • "name": "string",
  • "version": "string",
  • "vendor": "string",
  • "uptime": 0,
  • "startTime": 0,
  • "loadedClassCount": 0,
  • "totalLoadedClassCount": 0,
  • "unloadedClassCount": 0,
  • "garbageCollectors": {

    • "property1": {

      • "collectionCount": 0,
      • "collectionTime": 0

      },
    • "property2": {

      • "collectionCount": 0,
      • "collectionTime": 0

      }

    },
  • "systemProperties": {

    • "property1": "string",
    • "property2": "string"

    }

  },
• "cpu": {

  • "availableProcessors": 0,
  • "architecture": "string",
  • "name": "string",
  • "version": "string",
  • "systemCpuLoad": 0.1,
  • "processCpuLoad": 0.1,
  • "systemLoadAverage": 0.1,
  • "totalPhysicalMemorySize": 0,
  • "freePhysicalMemorySize": 0,
  • "totalSwapSpaceSize": 0,
  • "freeSwapSpaceSize": 0,
  • "committedVirtualMemorySize": 0,
  • "maxMemory": 0,
  • "totalMemory": 0,
  • "freeMemory": 0,
  • "usedMemory": 0

  },
• "memory": {

  • "heap": {

    • "init": 0,
    • "used": 0,
    • "committed": 0,
    • "max": 0,
    • "usagePercentage": 0.1

    },
  • "nonHeap": {

    • "init": 0,
    • "used": 0,
    • "committed": 0,
    • "max": 0,
    • "usagePercentage": 0.1

    },
  • "memoryPools": {

    • "property1": {

      • "init": 0,
      • "used": 0,
      • "committed": 0,
      • "max": 0,
      • "usagePercentage": 0.1,
      • "type": "string",
      • "memoryManagerNames": "string"

      },
    • "property2": {

      • "init": 0,
      • "used": 0,
      • "committed": 0,
      • "max": 0,
      • "usagePercentage": 0.1,
      • "type": "string",
      • "memoryManagerNames": "string"

      }

    }

  },
• "threads": {

  • "threadCount": 0,
  • "peakThreadCount": 0,
  • "daemonThreadCount": 0,
  • "totalStartedThreadCount": 0,
  • "currentThreadCpuTime": 0,
  • "currentThreadUserTime": 0,
  • "threadStates": {

    • "property1": 0,
    • "property2": 0

    },
  • "threadDetails": {

    • "property1": {

      • "name": "string",
      • "state": "string",
      • "blockedTime": 0,
      • "blockedCount": 0,
      • "waitedTime": 0,
      • "waitedCount": 0,
      • "cpuTime": 0,
      • "userTime": 0,
      • "lockName": "string",
      • "lockOwnerName": "string"

      },
    • "property2": {

      • "name": "string",
      • "state": "string",
      • "blockedTime": 0,
      • "blockedCount": 0,
      • "waitedTime": 0,
      • "waitedCount": 0,
      • "cpuTime": 0,
      • "userTime": 0,
      • "lockName": "string",
      • "lockOwnerName": "string"

      }

    }

  },
• "disk": {

  • "fileSystems": {

    • "property1": {

      • "name": "string",
      • "type": "string",
      • "totalSpace": 0,
      • "usedSpace": 0,
      • "usableSpace": 0,
      • "freeSpace": 0,
      • "usagePercentage": 0.1,
      • "isReadOnly": true,
      • "totalSpaceGB": 0.1,
      • "usedSpaceGB": 0.1,
      • "usableSpaceGB": 0.1,
      • "freeSpaceGB": 0.1,
      • "lastModified": 0,
      • "readOnly": true

      },
    • "property2": {

      • "name": "string",
      • "type": "string",
      • "totalSpace": 0,
      • "usedSpace": 0,
      • "usableSpace": 0,
      • "freeSpace": 0,
      • "usagePercentage": 0.1,
      • "isReadOnly": true,
      • "totalSpaceGB": 0.1,
      • "usedSpaceGB": 0.1,
      • "usableSpaceGB": 0.1,
      • "freeSpaceGB": 0.1,
      • "lastModified": 0,
      • "readOnly": true

      }

    },
  • "rootDirectory": {

    • "name": "string",
    • "type": "string",
    • "totalSpace": 0,
    • "usedSpace": 0,
    • "usableSpace": 0,
    • "freeSpace": 0,
    • "usagePercentage": 0.1,
    • "isReadOnly": true,
    • "totalSpaceGB": 0.1,
    • "usedSpaceGB": 0.1,
    • "usableSpaceGB": 0.1,
    • "freeSpaceGB": 0.1,
    • "lastModified": 0,
    • "readOnly": true

    },
  • "totalFileSystems": 0,
  • "totalSpace": 0,
  • "totalUsableSpace": 0,
  • "totalFreeSpace": 0,
  • "diskIo": {

    • "committedVirtualMemorySize": 0,
    • "processIo": {

      • "committedVirtualMemoryMB": 0

      },
    • "fileSystemStats": {

      • "totalSpace": 0,
      • "freeSpace": 0,
      • "usableSpace": 0,
      • "lastModified": 0,
      • "spaceUtilization": 0.1

      },
    • "jvmIo": {

      • "maxMemory": 0,
      • "totalMemory": 0,
      • "freeMemory": 0,
      • "usedMemory": 0

      },
    • "error": "string",
    • "fileSystemError": "string"

    }

  },
• "network": {

  • "interfaces": {

    • "property1": {

      • "name": "string",
      • "displayName": "string",
      • "isUp": true,
      • "isLoopback": true,
      • "isVirtual": true,
      • "isPointToPoint": true,
      • "supportsMulticast": true,
      • "macAddress": "string",
      • "mtu": 0,
      • "addresses": {

        • "property1": {

          • "address": "string",
          • "hostName": "string",
          • "networkPrefixLength": 0,
          • "broadcast": "string"

          },
        • "property2": {

          • "address": "string",
          • "hostName": "string",
          • "networkPrefixLength": 0,
          • "broadcast": "string"

          }

        },
      • "parent": "string",
      • "subInterfaces": {

        • "property1": "string",
        • "property2": "string"

        },
      • "up": true,
      • "loopback": true,
      • "virtual": true,
      • "pointToPoint": true

      },
    • "property2": {

      • "name": "string",
      • "displayName": "string",
      • "isUp": true,
      • "isLoopback": true,
      • "isVirtual": true,
      • "isPointToPoint": true,
      • "supportsMulticast": true,
      • "macAddress": "string",
      • "mtu": 0,
      • "addresses": {

        • "property1": {

          • "address": "string",
          • "hostName": "string",
          • "networkPrefixLength": 0,
          • "broadcast": "string"

          },
        • "property2": {

          • "address": "string",
          • "hostName": "string",
          • "networkPrefixLength": 0,
          • "broadcast": "string"

          }

        },
      • "parent": "string",
      • "subInterfaces": {

        • "property1": "string",
        • "property2": "string"

        },
      • "up": true,
      • "loopback": true,
      • "virtual": true,
      • "pointToPoint": true

      }

    },
  • "totalInterfaces": 0,
  • "localhost": {

    • "hostName": "string",
    • "hostAddress": "string",
    • "canonicalHostName": "string",
    • "isLoopbackAddress": true,
    • "isLinkLocalAddress": true,
    • "isSiteLocalAddress": true,
    • "isMulticastAddress": true,
    • "loopbackAddress": true,
    • "linkLocalAddress": true,
    • "siteLocalAddress": true,
    • "multicastAddress": true

    },
  • "stats": {

    • "activeInterfaces": 0,
    • "timestamp": 0

    },
  • "localhostError": "string"

  },
• "summary": {

  • "systemTime": 0,
  • "uptime": 0,
  • "availableProcessors": 0,
  • "osName": "string",
  • "osVersion": "string",
  • "osArch": "string",
  • "heapUsedMB": 0,
  • "heapMaxMB": 0,
  • "heapUsagePercentage": 0.1,
  • "threadCount": 0,
  • "peakThreadCount": 0,
  • "daemonThreadCount": 0,
  • "diskTotalSpaceGB": 0.1,
  • "diskUsableSpaceGB": 0.1,
  • "diskFreeSpaceGB": 0.1,
  • "diskUsagePercentage": 0.1,
  • "totalNetworkInterfaces": 0,
  • "upNetworkInterfaces": 0,
  • "hostName": "string",
  • "hostAddress": "string",
  • "networkError": "string",
  • "jvmName": "string",
  • "jvmVersion": "string",
  • "jvmVendor": "string",
  • "loadedClassCount": 0,
  • "totalLoadedClassCount": 0,
  • "totalGcCount": 0,
  • "totalGcTime": 0,
  • "systemCpuLoad": 0.1,
  • "processCpuLoad": 0.1

  },
• "prometheus": {

  • "metrics": "string",
  • "error": "string"

  },
• "fm": {

  • "customApiCount": 0,
  • "requestCount": 0,
  • "queryCount": 0,
  • "mutationCount": 0,
  • "subscribeCount": 0,
  • "dataSourceCount": 0,
  • "modelCount": 0,
  • "flowDefCount": 0,
  • "flowExecCount": 0,
  • "triggerTotalCount": 0,
  • "jobSuccessCount": 0,
  • "jobFailureCount": 0

  },
• "timestamp": 0,
• "processingTimeMs": 0,
• "error": "string"

}

获取CPU监控信息

返回CPU使用率、系统负载、物理内存等系统资源信息

Authorizations:

BearerAuthBearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/metrics/cpu

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "availableProcessors": 0,
• "architecture": "string",
• "name": "string",
• "version": "string",
• "systemCpuLoad": 0.1,
• "processCpuLoad": 0.1,
• "systemLoadAverage": 0.1,
• "totalPhysicalMemorySize": 0,
• "freePhysicalMemorySize": 0,
• "totalSwapSpaceSize": 0,
• "freeSwapSpaceSize": 0,
• "committedVirtualMemorySize": 0,
• "maxMemory": 0,
• "totalMemory": 0,
• "freeMemory": 0,
• "usedMemory": 0

}

获取磁盘监控信息

返回磁盘使用情况、文件系统信息、磁盘I/O统计等存储设备监控数据

Authorizations:

BearerAuthBearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/metrics/disk

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "fileSystems": {

  • "property1": {

    • "name": "string",
    • "type": "string",
    • "totalSpace": 0,
    • "usedSpace": 0,
    • "usableSpace": 0,
    • "freeSpace": 0,
    • "usagePercentage": 0.1,
    • "isReadOnly": true,
    • "totalSpaceGB": 0.1,
    • "usedSpaceGB": 0.1,
    • "usableSpaceGB": 0.1,
    • "freeSpaceGB": 0.1,
    • "lastModified": 0,
    • "readOnly": true

    },
  • "property2": {

    • "name": "string",
    • "type": "string",
    • "totalSpace": 0,
    • "usedSpace": 0,
    • "usableSpace": 0,
    • "freeSpace": 0,
    • "usagePercentage": 0.1,
    • "isReadOnly": true,
    • "totalSpaceGB": 0.1,
    • "usedSpaceGB": 0.1,
    • "usableSpaceGB": 0.1,
    • "freeSpaceGB": 0.1,
    • "lastModified": 0,
    • "readOnly": true

    }

  },
• "rootDirectory": {

  • "name": "string",
  • "type": "string",
  • "totalSpace": 0,
  • "usedSpace": 0,
  • "usableSpace": 0,
  • "freeSpace": 0,
  • "usagePercentage": 0.1,
  • "isReadOnly": true,
  • "totalSpaceGB": 0.1,
  • "usedSpaceGB": 0.1,
  • "usableSpaceGB": 0.1,
  • "freeSpaceGB": 0.1,
  • "lastModified": 0,
  • "readOnly": true

  },
• "totalFileSystems": 0,
• "totalSpace": 0,
• "totalUsableSpace": 0,
• "totalFreeSpace": 0,
• "diskIo": {

  • "committedVirtualMemorySize": 0,
  • "processIo": {

    • "committedVirtualMemoryMB": 0

    },
  • "fileSystemStats": {

    • "totalSpace": 0,
    • "freeSpace": 0,
    • "usableSpace": 0,
    • "lastModified": 0,
    • "spaceUtilization": 0.1

    },
  • "jvmIo": {

    • "maxMemory": 0,
    • "totalMemory": 0,
    • "freeMemory": 0,
    • "usedMemory": 0

    },
  • "error": "string",
  • "fileSystemError": "string"

  }

}

Get Fm Metrics

Authorizations:

BearerAuthBearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/metrics/fm

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "customApiCount": 0,
• "requestCount": 0,
• "queryCount": 0,
• "mutationCount": 0,
• "subscribeCount": 0,
• "dataSourceCount": 0,
• "modelCount": 0,
• "flowDefCount": 0,
• "flowExecCount": 0,
• "triggerTotalCount": 0,
• "jobSuccessCount": 0,
• "jobFailureCount": 0

}

获取JVM监控信息

返回JVM运行时的详细信息，包括类加载、垃圾回收、系统属性等

Authorizations:

BearerAuthBearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/metrics/jvm

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "version": "string",
• "vendor": "string",
• "uptime": 0,
• "startTime": 0,
• "loadedClassCount": 0,
• "totalLoadedClassCount": 0,
• "unloadedClassCount": 0,
• "garbageCollectors": {

  • "property1": {

    • "collectionCount": 0,
    • "collectionTime": 0

    },
  • "property2": {

    • "collectionCount": 0,
    • "collectionTime": 0

    }

  },
• "systemProperties": {

  • "property1": "string",
  • "property2": "string"

  }

}

获取内存监控信息

返回堆内存、非堆内存、内存池等详细内存使用情况

Authorizations:

BearerAuthBearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/metrics/memory

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "heap": {

  • "init": 0,
  • "used": 0,
  • "committed": 0,
  • "max": 0,
  • "usagePercentage": 0.1

  },
• "nonHeap": {

  • "init": 0,
  • "used": 0,
  • "committed": 0,
  • "max": 0,
  • "usagePercentage": 0.1

  },
• "memoryPools": {

  • "property1": {

    • "init": 0,
    • "used": 0,
    • "committed": 0,
    • "max": 0,
    • "usagePercentage": 0.1,
    • "type": "string",
    • "memoryManagerNames": "string"

    },
  • "property2": {

    • "init": 0,
    • "used": 0,
    • "committed": 0,
    • "max": 0,
    • "usagePercentage": 0.1,
    • "type": "string",
    • "memoryManagerNames": "string"

    }

  }

}

获取网络监控信息

返回网络接口信息、连接状态、IP地址等网络监控数据

Authorizations:

BearerAuthBearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/metrics/network

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "interfaces": {

  • "property1": {

    • "name": "string",
    • "displayName": "string",
    • "isUp": true,
    • "isLoopback": true,
    • "isVirtual": true,
    • "isPointToPoint": true,
    • "supportsMulticast": true,
    • "macAddress": "string",
    • "mtu": 0,
    • "addresses": {

      • "property1": {

        • "address": "string",
        • "hostName": "string",
        • "networkPrefixLength": 0,
        • "broadcast": "string"

        },
      • "property2": {

        • "address": "string",
        • "hostName": "string",
        • "networkPrefixLength": 0,
        • "broadcast": "string"

        }

      },
    • "parent": "string",
    • "subInterfaces": {

      • "property1": "string",
      • "property2": "string"

      },
    • "up": true,
    • "loopback": true,
    • "virtual": true,
    • "pointToPoint": true

    },
  • "property2": {

    • "name": "string",
    • "displayName": "string",
    • "isUp": true,
    • "isLoopback": true,
    • "isVirtual": true,
    • "isPointToPoint": true,
    • "supportsMulticast": true,
    • "macAddress": "string",
    • "mtu": 0,
    • "addresses": {

      • "property1": {

        • "address": "string",
        • "hostName": "string",
        • "networkPrefixLength": 0,
        • "broadcast": "string"

        },
      • "property2": {

        • "address": "string",
        • "hostName": "string",
        • "networkPrefixLength": 0,
        • "broadcast": "string"

        }

      },
    • "parent": "string",
    • "subInterfaces": {

      • "property1": "string",
      • "property2": "string"

      },
    • "up": true,
    • "loopback": true,
    • "virtual": true,
    • "pointToPoint": true

    }

  },
• "totalInterfaces": 0,
• "localhost": {

  • "hostName": "string",
  • "hostAddress": "string",
  • "canonicalHostName": "string",
  • "isLoopbackAddress": true,
  • "isLinkLocalAddress": true,
  • "isSiteLocalAddress": true,
  • "isMulticastAddress": true,
  • "loopbackAddress": true,
  • "linkLocalAddress": true,
  • "siteLocalAddress": true,
  • "multicastAddress": true

  },
• "stats": {

  • "activeInterfaces": 0,
  • "timestamp": 0

  },
• "localhostError": "string"

}

获取Prometheus格式指标

返回Prometheus格式的监控指标数据，可用于Prometheus服务器采集

Authorizations:

BearerAuthBearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/metrics/prometheus

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "metrics": "string",
• "error": "string"

}

获取系统摘要信息

返回系统运行状态的综合摘要，包括JVM、CPU、内存、线程等关键指标

Authorizations:

BearerAuthBearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/metrics/summary

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "systemTime": 0,
• "uptime": 0,
• "availableProcessors": 0,
• "osName": "string",
• "osVersion": "string",
• "osArch": "string",
• "heapUsedMB": 0,
• "heapMaxMB": 0,
• "heapUsagePercentage": 0.1,
• "threadCount": 0,
• "peakThreadCount": 0,
• "daemonThreadCount": 0,
• "diskTotalSpaceGB": 0.1,
• "diskUsableSpaceGB": 0.1,
• "diskFreeSpaceGB": 0.1,
• "diskUsagePercentage": 0.1,
• "totalNetworkInterfaces": 0,
• "upNetworkInterfaces": 0,
• "hostName": "string",
• "hostAddress": "string",
• "networkError": "string",
• "jvmName": "string",
• "jvmVersion": "string",
• "jvmVendor": "string",
• "loadedClassCount": 0,
• "totalLoadedClassCount": 0,
• "totalGcCount": 0,
• "totalGcTime": 0,
• "systemCpuLoad": 0.1,
• "processCpuLoad": 0.1

}

获取线程监控信息

返回线程数量、状态统计、线程详细信息等

Authorizations:

BearerAuthBearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/metrics/threads

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "threadCount": 0,
• "peakThreadCount": 0,
• "daemonThreadCount": 0,
• "totalStartedThreadCount": 0,
• "currentThreadCpuTime": 0,
• "currentThreadUserTime": 0,
• "threadStates": {

  • "property1": 0,
  • "property2": 0

  },
• "threadDetails": {

  • "property1": {

    • "name": "string",
    • "state": "string",
    • "blockedTime": 0,
    • "blockedCount": 0,
    • "waitedTime": 0,
    • "waitedCount": 0,
    • "cpuTime": 0,
    • "userTime": 0,
    • "lockName": "string",
    • "lockOwnerName": "string"

    },
  • "property2": {

    • "name": "string",
    • "state": "string",
    • "blockedTime": 0,
    • "blockedCount": 0,
    • "waitedTime": 0,
    • "waitedCount": 0,
    • "cpuTime": 0,
    • "userTime": 0,
    • "lockName": "string",
    • "lockOwnerName": "string"

    }

  }

}

【Flexmodel】触发器

触发器管理

获取触发器列表

Authorizations:

BearerAuth

query Parameters

jobGroup	string
jobId	string
jobType	string
name	string
page	integer <int32> Default: "1"
size	integer <int32> Default: "15"

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/triggers

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "list": [

  • {

    • "id": "string",
    • "name": "string",
    • "description": "string",
    • "type": "EVENT",
    • "config": null,
    • "jobType": "string",
    • "jobGroup": "string",
    • "jobId": "string",
    • "state": true,
    • "createdAt": "2022-03-10T12:15:50",
    • "updatedAt": "2022-03-10T12:15:50",
    • "createdBy": "string",
    • "updatedBy": "string",
    • "tenantId": "string",
    • "jobName": "string",
    • "nextFireTime": "2022-03-10T12:15:50",
    • "previousFireTime": "2022-03-10T12:15:50"

    }

  ],
• "total": 0

}

创建触发器

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

id	string
name	string
description	string
type	string (TriggerType) Enum: "EVENT" "SCHEDULED"
config	any
jobType	string
jobGroup	string
jobId	string
state	boolean
createdAt	string <date-time> (LocalDateTime)
updatedAt	string <date-time> (LocalDateTime)
createdBy	string
updatedBy	string
tenantId	string

Responses

https://preview.flexmodel.wetech.tech/api/f/triggers

Request samples

• Payload

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "type": "EVENT",
• "config": null,
• "jobType": "string",
• "jobGroup": "string",
• "jobId": "string",
• "state": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "createdBy": "string",
• "updatedBy": "string",
• "tenantId": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "type": "EVENT",
• "config": null,
• "jobType": "string",
• "jobGroup": "string",
• "jobId": "string",
• "state": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "createdBy": "string",
• "updatedBy": "string",
• "tenantId": "string"

}

更新触发器

Authorizations:

BearerAuth

path Parameters

id required

string

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

id	string
name	string
description	string
type	string (TriggerType) Enum: "EVENT" "SCHEDULED"
config	any
jobType	string
jobGroup	string
jobId	string
state	boolean
createdAt	string <date-time> (LocalDateTime)
updatedAt	string <date-time> (LocalDateTime)
createdBy	string
updatedBy	string
tenantId	string

Responses

https://preview.flexmodel.wetech.tech/api/f/triggers/{id}

Request samples

• Payload

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "type": "EVENT",
• "config": null,
• "jobType": "string",
• "jobGroup": "string",
• "jobId": "string",
• "state": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "createdBy": "string",
• "updatedBy": "string",
• "tenantId": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "type": "EVENT",
• "config": null,
• "jobType": "string",
• "jobGroup": "string",
• "jobId": "string",
• "state": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "createdBy": "string",
• "updatedBy": "string",
• "tenantId": "string"

}

部分更新触发器

Authorizations:

BearerAuth

path Parameters

id required

string

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

id	string
name	string
description	string
type	string (TriggerType) Enum: "EVENT" "SCHEDULED"
config	any
jobType	string
jobGroup	string
jobId	string
state	boolean
createdAt	string <date-time> (LocalDateTime)
updatedAt	string <date-time> (LocalDateTime)
createdBy	string
updatedBy	string
tenantId	string

Responses

https://preview.flexmodel.wetech.tech/api/f/triggers/{id}

Request samples

• Payload

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "type": "EVENT",
• "config": null,
• "jobType": "string",
• "jobGroup": "string",
• "jobId": "string",
• "state": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "createdBy": "string",
• "updatedBy": "string",
• "tenantId": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "type": "EVENT",
• "config": null,
• "jobType": "string",
• "jobGroup": "string",
• "jobId": "string",
• "state": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "createdBy": "string",
• "updatedBy": "string",
• "tenantId": "string"

}

获取单个触发器

Authorizations:

BearerAuth

path Parameters

id required

string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/triggers/{id}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "type": "EVENT",
• "config": null,
• "jobType": "string",
• "jobGroup": "string",
• "jobId": "string",
• "state": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "createdBy": "string",
• "updatedBy": "string",
• "tenantId": "string",
• "jobName": "string",
• "nextFireTime": "2022-03-10T12:15:50",
• "previousFireTime": "2022-03-10T12:15:50"

}

删除触发器

Authorizations:

BearerAuth

path Parameters

id required

string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/triggers/{id}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

立即执行触发器

Authorizations:

BearerAuth

path Parameters

id required

string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/triggers/{id}/execute

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": "string",
• "name": "string",
• "description": "string",
• "type": "EVENT",
• "config": null,
• "jobType": "string",
• "jobGroup": "string",
• "jobId": "string",
• "state": true,
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "createdBy": "string",
• "updatedBy": "string",
• "tenantId": "string"

}

【Flexmodel】记录

模型数据记录管理

获取模型数据记录列表

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 模型名称
modelName required	string

query Parameters

page	integer <int32> Default: 1 Examples: 当前页，默认值：1
size	integer <int32> Default: 15 Examples: 第几页，默认值：15
filter	string Examples: 查询条件，更多信息见查询条件文档
nestedQuery	boolean Default: false Examples: 是否开启嵌套子查询，开启则查询关联数据，只查询5层，默认值false
sort	string Examples: 排序

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}/records

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "total": null,
• "list": [

  • { }

  ]

}

创建模型数据记录

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 模型名称
modelName required	string

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

property name* additional property

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}/records

Request samples

• Payload

Content type

application/json

{

• "studentName": "张三",
• "gender": "MALE",
• "interest": [

  • "chang",
  • "tiao",
  • "rap",
  • "daLanQiu"

  ],
• "age": 10,
• "classId": 1,
• "studentDetail": {

  • "description": "张三的描述"

  },
• "courses": [

  • {

    • "courseNo": "Math",
    • "courseName": "数学"

    },
  • {

    • "courseNo": "YuWen",
    • "courseName": "语文"

    },
  • {

    • "courseNo": "Eng",
    • "courseName": "英语"

    }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "property1": null,
• "property2": null

}

更新模型数据记录(局部更新)

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 模型名称
modelName required	string
id required	string Examples: ID

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

property name* additional property

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}/records/{id}

Request samples

• Payload

Content type

application/json

{

• "studentName": "张三",
• "gender": "MALE",
• "interest": [

  • "chang",
  • "tiao",
  • "rap",
  • "daLanQiu"

  ],
• "age": 10,
• "classId": 1,
• "studentDetail": {

  • "description": "张三的描述"

  },
• "courses": [

  • {

    • "courseNo": "Math",
    • "courseName": "数学"

    },
  • {

    • "courseNo": "YuWen",
    • "courseName": "语文"

    },
  • {

    • "courseNo": "Eng",
    • "courseName": "英语"

    }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "property1": null,
• "property2": null

}

更新模型数据记录

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 模型名称
modelName required	string
id required	string Examples: ID

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

property name* additional property

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}/records/{id}

Request samples

• Payload

Content type

application/json

{

• "id": 1,
• "studentName": "张三",
• "gender": "MALE",
• "interest": [

  • "chang",
  • "tiao",
  • "rap",
  • "daLanQiu"

  ],
• "age": 10,
• "classId": 1,
• "studentDetail": {

  • "description": "张三的描述"

  },
• "courses": [

  • {

    • "courseNo": "Math",
    • "courseName": "数学"

    },
  • {

    • "courseNo": "YuWen",
    • "courseName": "语文"

    },
  • {

    • "courseNo": "Eng",
    • "courseName": "英语"

    }

  ]

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "property1": null,
• "property2": null

}

获取单条模型数据记录

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 模型名称
modelName required	string
id required	string Examples: ID

query Parameters

nestedQuery

boolean Default: false

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}/records/{id}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "property1": null,
• "property2": null

}

删除模型数据记录

Authorizations:

BearerAuth

path Parameters

datasourceName required	string 模型名称
modelName required	string
id required	string Examples: ID

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/datasources/{datasourceName}/models/{modelName}/records/{id}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

【Flexmodel】设置

系统设置

保存设置

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

appName	string
	object (Log)
	object (Security)
	object (Proxy)

Responses

https://preview.flexmodel.wetech.tech/api/f/settings

Request samples

• Payload

Content type

application/json

{

• "appName": "string",
• "log": {

  • "maxDays": 0,
  • "consoleLoggingEnabled": true

  },
• "security": {

  • "rateLimitingEnabled": true,
  • "maxRequestCount": 0,
  • "intervalInSeconds": 0,
  • "graphqlEndpointPath": "string",
  • "graphqlEndpointIdentityProvider": "string",
  • "systemIdentityProvider": "string"

  },
• "proxy": {

  • "routesEnabled": true,
  • "routes": [

    • {

      • "path": "string",
      • "to": "string"

      }

    ]

  }

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "appName": "string",
• "log": {

  • "maxDays": 0,
  • "consoleLoggingEnabled": true

  },
• "security": {

  • "rateLimitingEnabled": true,
  • "maxRequestCount": 0,
  • "intervalInSeconds": 0,
  • "graphqlEndpointPath": "string",
  • "graphqlEndpointIdentityProvider": "string",
  • "systemIdentityProvider": "string"

  },
• "proxy": {

  • "routesEnabled": true,
  • "routes": [

    • {

      • "path": "string",
      • "to": "string"

      }

    ]

  }

}

获取设置

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/settings

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "appName": "string",
• "log": {

  • "maxDays": 0,
  • "consoleLoggingEnabled": true

  },
• "security": {

  • "rateLimitingEnabled": true,
  • "maxRequestCount": 0,
  • "intervalInSeconds": 0,
  • "graphqlEndpointPath": "string",
  • "graphqlEndpointIdentityProvider": "string",
  • "systemIdentityProvider": "string"

  },
• "proxy": {

  • "routesEnabled": true,
  • "routes": [

    • {

      • "path": "string",
      • "to": "string"

      }

    ]

  }

}

【Flexmodel】身份源

身份源管理

获取身份源列表

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/identity-providers

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "name": "string",
  • "provider": { },
  • "createdAt": "2022-03-10T12:15:50",
  • "updatedAt": "2022-03-10T12:15:50",
  • "tenantId": "string",
  • "createdBy": "string",
  • "updatedBy": "string"

  }

]

创建身份源

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

name	string 名称，需要唯一
provider	object 身份源配置
tenantId	string
createdBy	string
updatedBy	string

Responses

https://preview.flexmodel.wetech.tech/api/f/identity-providers

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "provider": { },
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "provider": { },
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

更新身份源

Authorizations:

BearerAuth

path Parameters

name required

string 名称

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

name	string 名称，需要唯一
provider	object 身份源配置
tenantId	string
createdBy	string
updatedBy	string

Responses

https://preview.flexmodel.wetech.tech/api/f/identity-providers/{name}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "provider": { },
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "name": "string",
• "provider": { },
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50",
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string"

}

删除身份源

Authorizations:

BearerAuth

path Parameters

name required

string 名称

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/identity-providers/{name}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

Ai Chat Resource

Chat Completions

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

conversationId	string
model	string
	Array of objects (ChatMessage)
temperature	number <double>
maxTokens	integer <int32>

Responses

https://preview.flexmodel.wetech.tech/api/f/ai/chat/completions

Request samples

• Payload

Content type

application/json

{

• "conversationId": "string",
• "model": "string",
• "messages": [

  • {

    • "role": "string",
    • "content": "string"

    }

  ],
• "temperature": 0.1,
• "maxTokens": 0

}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

List Conversations

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/ai/chat/conversations

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "id": "string",
  • "title": "string",
  • "messages": [

    • {

      • "id": "string",
      • "conversationId": "string",
      • "role": "string",
      • "content": "string",
      • "tenantId": "string",
      • "createdBy": "string",
      • "updatedBy": "string",
      • "createdAt": "2022-03-10T12:15:50",
      • "updatedAt": "2022-03-10T12:15:50"

      }

    ],
  • "tenantId": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2022-03-10T12:15:50",
  • "updatedAt": "2022-03-10T12:15:50"

  }

]

Create Conversation

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

title

string

Responses

https://preview.flexmodel.wetech.tech/api/f/ai/chat/conversations

Request samples

• Payload

Content type

application/json

{

• "title": "string"

}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": "string",
• "title": "string",
• "messages": [

  • {

    • "id": "string",
    • "conversationId": "string",
    • "role": "string",
    • "content": "string",
    • "tenantId": "string",
    • "createdBy": "string",
    • "updatedBy": "string",
    • "createdAt": "2022-03-10T12:15:50",
    • "updatedAt": "2022-03-10T12:15:50"

    }

  ],
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50"

}

Get Conversation

Authorizations:

BearerAuth

path Parameters

id required

string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/ai/chat/conversations/{id}

Response samples

• 200
• 400
• 500

Content type

application/json

{

• "id": "string",
• "title": "string",
• "messages": [

  • {

    • "id": "string",
    • "conversationId": "string",
    • "role": "string",
    • "content": "string",
    • "tenantId": "string",
    • "createdBy": "string",
    • "updatedBy": "string",
    • "createdAt": "2022-03-10T12:15:50",
    • "updatedAt": "2022-03-10T12:15:50"

    }

  ],
• "tenantId": "string",
• "createdBy": "string",
• "updatedBy": "string",
• "createdAt": "2022-03-10T12:15:50",
• "updatedAt": "2022-03-10T12:15:50"

}

Delete Conversation

Authorizations:

BearerAuth

path Parameters

id required

string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/ai/chat/conversations/{id}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

Send Message

Authorizations:

BearerAuth

path Parameters

id required

string

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

content	string
model	string

Responses

https://preview.flexmodel.wetech.tech/api/f/ai/chat/conversations/{id}/messages

Request samples

• Payload

Content type

application/json

{

• "content": "string",
• "model": "string"

}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

List Messages

Authorizations:

BearerAuth

path Parameters

id required

string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/ai/chat/conversations/{id}/messages

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "id": "string",
  • "conversationId": "string",
  • "role": "string",
  • "content": "string",
  • "tenantId": "string",
  • "createdBy": "string",
  • "updatedBy": "string",
  • "createdAt": "2022-03-10T12:15:50",
  • "updatedAt": "2022-03-10T12:15:50"

  }

]

Auth Resource

Login

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Request Body schema: application/json

required

username	string
password	string

Responses

https://preview.flexmodel.wetech.tech/api/f/auth/login

Request samples

• Payload

Content type

application/json

{

• "username": "string",
• "password": "string"

}

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

Refresh

Authorizations:

BearerAuth

cookie Parameters

refreshToken

string

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/auth/refresh

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

Get User Info

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/auth/whoami

Response samples

• 400
• 500

Content type

application/json

{

• "code": 1001,
• "message": "参数验证异常",
• "success": false,
• "errors": [

  • {

    • "field": "name",
    • "message": "不能为空"

    }

  ]

}

Tenant Resource

Find Tenants

Authorizations:

BearerAuth

header Parameters

X-Tenant-Id

any

Responses

https://preview.flexmodel.wetech.tech/api/f/tenants

Response samples

• 200
• 400
• 500

Content type

application/json

[

• {

  • "id": "string",
  • "enabled": true,
  • "createdAt": "2022-03-10T12:15:50",
  • "updatedAt": "2022-03-10T12:15:50"

  }

]