REST API

Overview

REST API

Return Value Interface Specification

Name	Location	Type	Description
request_id	body	string	Unique request identifier ID
status	body	string	Request status: Success/Failed
error_code	body	string	Error code, present when status is Failed
error_message	body	string	Error message, present when status is Failed
detail_message	body	string	Detailed error message, possibly present when status is Failed
data	body	object	Returned result data, generally present when status is Success

Authentication

POST Token Refresh

POST /oauth2/token

Request Parameters

Name	Location	Type	Required	Description
body	body	object	No	none
» refresh_token	body	string	No	none
» grant_type	body	string	No	none
» client_id	body	string	No	none
» client_secret	body	string	No	none
» username	body	string	No	none
» password	body	string	No	none

Body Request Parameters

refresh_token: string
grant_type: password
client_id: iab
client_secret: milesight*iab
username: string
password: string

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "access_token": "string",
  "expires_in": 0,
  "refresh_token:":"string"
}

POST User Registration

POST /user/register

Request Parameters

Name	Location	Type	Required	Description
body	body	object	No	none
» email	body	string	Yes	none
» nickname	body	string	Yes	none
» password	body	string	Yes	none

Body Request Parameters

{
  "email": "string",
  "nickname": "string",
  "password": "string"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{}

GET User Information

GET /user

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": {
    "tenant_id": "string",
    "user_id": "string",
    "nickname": "string",
    "email": "string",
    "created_at": "string",
    "roles": [{
      "role_id": "string",
      "role_name": "string"
    }],
    "menus": [
      {
        "menu_id": "",
        "code": "",
        "name": "",
        "type": "",
        "parent_id":""
      }
    ],
    "super_admin": true
  }
}

GET User Status Information

GET /user/status

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": {
    "init": true
  }
}

Post user list (page)

Post /user/members/search

请求参数

名称	位置	类型	必选	说明
body	body	Object	否	none
» keyword	body	string	否	模糊匹配nickname或email

Body 请求参数

{
  "keyword": "string"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": {
    "tenant_id": "string",
    "user_id": "string",
    "nickname": "string",
    "email": "string",
    "created_at": "string",
    "roles": [{
      "role_id": "string",
      "role_name": "string"
    }]
  }
}

POST create user

POST /user/members

Request Parameters

Name	Location	Type	Required	Description
body	body	object	NO	none
» email	body	string	YES	none
» nickname	body	string	YES	none
» password	body	string	YES	none

Body REQUEST

{
  "email": "string",
  "nickname": "string",
  "password": "string"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{}

PUT edit user

PUT /user/members/{userId}

Request Parameters

Name	Location	Type	Required	Description
userId	path	string	YES	none
body	body	object	NO	none
» email	body	string	YES	none
» nickname	body	string	YES	none

Body REQUEST

{
  "email": "string",
  "nickname": "string"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{}

PUT RESET password

PUT /user/members/{userId}/change-password

Request Parameters

Name	Location	Type	Required	Description
userId	path	string	YES	none
body	body	object	NO	none
» password	body	string	NO	none

Body Request

{
  "password": "string"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{}

DELETE delete user

DELETE /user/members/{user_id}

Request Parameters

Name	Location	Type	Required	Description
---------	---	---	---	---
user_id	path	string	YES	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    
  }
}

POST batch delete user

POST /user/batch-delete

Request Parameters

Name	Location	Type	Required	Description
body	body	object	NO	none
» user_id_list	body	Array	YES	none

Body REQUEST

{
  "user_id_list": []
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{}

PUT edit password（self）

PUT /user/password

Request Parameters

Name	Location	Type	Required	Description
body	body	object	NO	none
» old_password	body	string	YES	none
» new_password	body	string	YES	none

Body Request

{
  "old_password": "string",
  "new_password": "string"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{}

GET user menu list

GET /user/members/{user_id}/menus

Request Parameters

Name	Location	Type	Required	Description
user_id	path	string	YES	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "menu_id": "",
      "code": "",
      "name": "",
      "type": "",
      "parent_id":""
    }
  ]
}

Post is has some resource permission

Post /user/members/{userId}/permission

请求参数

名称	位置	类型	必选	说明
userId	path	string	是	none
body	body	object	否	none
» resource_type	body	string	是	none
» resource_id	body	string	是	none

Body 请求参数

{
  "resource_type": "string",
  "resource_id": "string"
}

Request Parameters

Name	Location	Type	Required	Description
userId	path	string	YES	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "has_permission": true
}

POST create role

POST /user/roles

Request Parameters

Name	Location	Type	Required	Description
body	body	Object	NO	none
» name	body	string	YES	none
» description	body	string	NO	none

Body REQUEST

{
  "name": "string",
  "description": "string"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    "role_id": ""
  }
}

PUT update role

PUT /user/roles/{role_id}

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	YES	none
body	body	Object	NO	none
» name	body	string	YES	none
» description	body	string	NO	none

Body Request

{
  "name": "string",
  "description": "string"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    
  }
}

DELETE delete role

DELETE /user/roles/{role_id}

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	YES	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    
  }
}

GET role list(page)

Post /user/roles/search

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "role_id": "",
      "name": "",
      "description": "",
      "created_at": "",
      "user_role_count": "",
      "role_integration_count": ""
    }
  ]
}

GET user list in role

GET /user/roles/{role_id}/members

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	YES	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "user_id": "",
      "user_email": "",
      "user_nickname": "",
      "role_id":""
    }
  ]
}

GET menu list in role

GET /user/roles/{role_id}/menus

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	YES	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "menu_id": "",
      "code": "",
      "name": "",
      "type": "",
      "parent_id":""
    }
  ]
}

Post resource list in role

Post /user/roles/{role_id}/resources

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	Yes	none
body	body	Object	NO	none
» resource_type	body	string	NO	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "resource_id": "",
      "resource_type":""
    }
  ]
}

Post Integration list in role

Post /user/roles/{role_id}/integrations

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	Yes	none
body	body	Object	NO	none
» keyword	body	string	NO	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "integration_id": "",
      "integration_name":"",
      "device_num":"",
      "entity_num": ""
    }
  ]
}

Post device list in role

Post /user/roles/{role_id}/devices

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	Yes	none
body	body	Object	no	none
» keyword	body	string	no	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "device_id": "",
      "device_name":"",
      "created_at": "",
      "integration_id": "",
      "integration_name":"",
      "user_id":"",
      "user_email": "",
      "user_nickname":"",
      "role_integration": "boolean"
    }
  ]
}

Post dashboard list in role

Post /user/roles/{role_id}/dashboards

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	yes	none
body	body	Object	no	none
» keyword	body	string	no	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "dashboard_id": "",
      "dashboard_name":"",
      "created_at": "",
      "user_id":"",
      "user_email": "",
      "user_nickname":""
    }
  ]
}

Post undistributed dashboard list

Post /user/roles/{role_id}/undistributed-dashboards

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	yes	none
body	body	Object	no	none
» keyword	body	string	no	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "dashboard_id": "",
      "dashboard_name":"",
      "created_at": "",
      "user_id":"",
      "user_email": "",
      "user_nickname":""
    }
  ]
}

Post undistributed user list

Post /user/roles/{role_id}/undistributed-users

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	yes	none
body	body	Object	no	none
» keyword	body	string	no	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "email": "",
      "nickname":"",
      "user_id":""
    }
  ]
}

Post undistributed integration list

Post /user/roles/{role_id}/undistributed-integrations

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	yes	none
body	body	Object	no	none
» keyword	body	string	no	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "integration_id": "",
      "integration_name":""
    }
  ]
}

Post undistributed device list

Post /user/roles/{role_id}/undistributed-devices

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	yes	none
body	body	Object	no	none
» keyword	body	string	no	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "device_id": "",
      "device_name":"",
      "created_at": "",
      "integration_id": "",
      "integration_name":"",
      "user_id":"",
      "user_email": "",
      "user_nickname":""
    }
  ]
}

POST add user to role

POST /user/roles/{role_id}/associate-user

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	yes	none
body	body	Object	no	none
» user_ids	body	Array	no	none

{
  "user_ids": ["",""]
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    
  }
}

POST add resource to role

POST /user/roles/{role_id}/associate-resource

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	yes	none
body	body	Object	no	none
» resources	body	Array	no	none
»» id	body	String	no	none
»» type	body	String[ENTITY, DEVICE, INTEGRATION, DASHBOARD, WORKFLOW]	否	none

{
  "resources": [
    {
      "id": "String",
      "type": "String" 
    }
  ]
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    
  }
}

POST disassociate user from role

POST /user/roles/{role_id}/disassociate-user

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	YES	none
body	body	Object	NO	none
» user_ids	body	Array	NO	none

{
  "user_ids": ["",""]
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    
  }
}

POST disassociate resource from role

POST /user/roles/{role_id}/disassociate-resource

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	YES	none
body	body	Object	no	none
» resources	body	Array	no	none
»» id	body	String	no	none
»» type	body	String[ENTITY, DEVICE, INTEGRATION, DASHBOARD, WORKFLOW]	否	none

{
  "resources": [
    {
      "id": "String",
      "type": "String" 
    }
  ]
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    
  }
}

POST create menu

POST /user/menus

Request Parameters

Name	Location	Type	Required	Description
body	body	Object	no	none
» code	body	string	yes	none
» name	body	string	yes	none
» type	body	string	yes	none
» parent_id	body	string	no	none

Body Request

{
  "code": "string",
  "name": "string",
  "type": "string",
  "parent_id":"string"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    "menu_id": ""
  }
}

PUT update menu

PUT /user/menus/{menu_id}

Request Parameters

Name	Location	Type	Required	Description
menu_id	path	string	yes	none
body	body	Object	no	none
» name	body	string	yes	none
» type	body	string [MENU,FUNCTION]	yes	none

Body request

{
  "name": "string",
  "type": "string"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    
  }
}

DELETE delete menu

DELETE /user/menus/{menu_id}

Request Parameters

Name	Location	Type	Required	Description
menu_id	path	string	yes	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    
  }
}

GET menu list

GET /user/menus

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "menu_id": "",
      "code": "",
      "name": "",
      "type": "",
      "parent_id": "",
      "children": []
    }
  ]
}

POST add menu to role

POST /user/roles/{role_id}/associate-menu

Request Parameters

Name	Location	Type	Required	Description
role_id	path	string	yes	none
body	body	Object	no	none
» menu_ids	body	Array	no	none

{
  "menu_ids": ["",""]
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    
  }
}

Integration

POST Get Integration List

POST /integration/search

Request Parameters

Name	Location	Type	Required	Description
device_addable	body	boolean	No	Whether to return integrations that can add devices
device_deletable	body	boolean	No	Whether to return integrations that can delete devices

Body Request Parameters

{
  "device_addable": true,
  "device_deletable": true
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "id": "",
      "icon": "",
      "name": "",
      "description": "",
      "add_device_service_key": "",
      "deviceCount": 0,
      "entityCount": 0
    }
  ]
}

GET Get Integration Details

GET /integration/{integration_id}

Request Parameters

Name	Location	Type	Required	Description
integration_id	path	string	Yes	Integration ID

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": {
    "id": "",
    "icon": "",
    "name": "",
    "description": "",
    "add_device_service_key": "",
    "deviceCount": 0,
    "entityCount": 0,
    "delete_device_service_key": "",
    "integration_entities": [
      {
        "id": "",
        "key": "",
        "name": "",
        "type": "",
        "value_attribute": {
          "": {}
        },
        "value_type": "",
        "access_mod": "",
        "parent": "",
        "value": {}
      }
    ]
  }
}

Devices

POST Create Device

POST /device

Request Parameters

Name	Location	Type	Required	Description
name	body	string	Yes	Device name
integration	body	string	Yes	Integration ID
param_entities	body	object	Yes	Parameters required for adding the device service

Body Request Parameters

{
  "name": "string",
  "integration": "string",
  "param_entities": {
    "key": "value"
  }
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{}

POST Search Devices

POST /device/search

Request Parameters

Name	Location	Type	Required	Description
name	body	string	No	Device name to search
page_number	body	number	No	Page number
page_size	body	number	No	Page size

Body Request Parameters

{
    "name": "",
    "page_number": 1,
    "page_size": 10
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
    "data": {
        "page_size": 0,
        "page_number": 0,
        "total": 0,
        "content": [
            {
                "id": "",
                "key": "",
                "name": "",
                "integration": "",
                "additional_data": {},
                "created_at": 0,
                "updated_at": 0,
                "integration_name": "",
                "deletable": true
            }
        ]
    }
}

PUT Update Device Information

PUT /device/{device_id}

Request Parameters

Name	Location	Type	Required	Description
device_id	path	string	Yes	Device ID
name	body	string	No	Device name

Body Request Parameters

{
  "name": "string"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{}

GET Get Device Details

GET /device/{device_id}

Request Parameters

Name	Location	Type	Required	Description
device_id	path	string	Yes	Device ID

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": {
    "id": "",
    "key": "",
    "name": "",
    "integration": "",
    "additional_data": {
      "": {}
    },
    "created_at": 0,
    "updated_at": 0,
    "integration_name": "",
    "deletable": false,
    "identifier": "",
    "entities": [
      {
        "id": "",
        "key": "",
        "name": "",
        "type": "",
        "value_attribute": {
          "": {}
        },
        "value_type": ""
      }
    ]
  }
}

POST Batch Delete Devices

POST /device/batch-delete

Request Parameters

Name	Location	Type	Required	Description
device_id_list	body	array	Yes	List of device IDs to delete
device_id_list.$	body	string	Yes	Device ID

Body Request Parameters

{
  "device_id_list": [
    "string"
  ]
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{}

Entities

POST Query Entities

POST /entity/search

Request Parameters

Name	Location	Type	Required	Description
body	body	object	No	none

Body Request Parameters

{
  "keyword": "string",
  "entity_type": "Array[PROPERTY, SERVICE, EVENT]",
  "exclude_children": "Boolean",
  "entity_value_type": "Array[STRING, LONG, DOUBLE, BOOLEAN, BINARY, OBJECT]",
  "entity_access_mod": "Array[R, W, RW]"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": {
    "device_name": "String",
    "integration_name": "String",
    "entity_id": "String",
    "entity_access_mod": "String",
    "entity_key": "String",
    "entity_name": "String",
    "entity_type": "String",
    "entity_value_attribute": {},
    "entity_value_type": "String"
  }
}

GET Get Child Entities

GET /entity/{entity_id}/children

Request Parameters

Name	Location	Type	Required	Description
entity_id	path	string	Yes	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "device_name": "",
      "integration_name": "",
      "entity_id": "",
      "entity_access_mod": "",
      "entity_key": "",
      "entity_type": "",
      "entity_name": "",
      "entity_value_attribute": {
        "": {}
      },
      "entity_value_type": ""
    }
  ]
}

POST Query Historical Data

POST /entity/history/search

Request Parameters

Body REQUEST

{
  "entity_id": 0,
  "start_timestamp": 0,
  "end_timestamp": 0
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "timestamp": 0,
  "value": "Object",
  "value_type": "String[STRING, LONG, DOUBLE, BOOLEAN, BINARY, OBJECT]"
}

POST Query Historical Data Aggregation

POST /entity/history/aggregate

Request Parameters

Name	Location	Type	Required	Description
body	body	object	No	none

Body 请求参数

{
  "entity_id": 0,
  "aggregate_type": "LAST",
  "start_timestamp": 0,
  "end_timestamp": 0
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    "value": {},
    "value_type": "",
    "count_result": [
      {
        "value": {},
        "value_type": "",
        "count": 0
      }
    ]
  }
}

GET Retrieve the Latest Value of an Entity

GET /entity/{entity_id}/status

Request Parameters

Name	Location	Type	Required	Description
entity_id	path	string	Yes	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    "value": {},
    "updated_at": "",
    "value_type": ""
  }
}

GET Retrieve Entity Metadata

GET /entity/{entity_id}/meta

Request Parameters

Name	Location	Type	Required	Description
entity_id	path	string	Yes	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    "key": "",
    "name": "",
    "type": "",
    "access_mod": "",
    "value_attribute": {
      "": {}
    },
    "value_type": ""
  }
}

Dashboard

POST Create Dashboard

POST /dashboard

Request Parameters

Name	Location	Type	Required	Description
body	body	Object	No	none
» name	body	string	Yes	none

Body Request Example

{
  "name": "string"
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    "dashboard_id": ""
  }
}

PUT Update Dashboard

PUT /dashboard/{dashboard_id}

Request Parameters

Name	Location	Type	Required	Description
dashboard_id	path	string	Yes	none
body	body	Object	No	none
» name	body	string	Yes	none
» widgets	body	Array	Yes	none
»» widget_id	body	string	Yes	none
»» data	body	Object	Yes	none

Body 请求参数

{
  "name": "string",
  "widgets": [
    {
      "widget_id": "string",
      "data": {
      }
    }
  ]
}

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    
  }
}

DELETE Delete Dashboard

DELETE /dashboard/{dashboard_id}

Request Parameters

Name	Location	Type	Required	Description
dashboardId	path	string	Yes	none

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data":{
    
  }
}

GET Retrieve All Dashboards

GET /dashboard/dashboards

Response

Status Code	Description	Data Model
200	OK	Success

Response Example

200 Response

{
  "data": [
    {
      "dashboard_id": "",
      "user_id":"",
      "name": "",
      "widgets": [
        {
          "widget_id": "",
          "data": {
            "": {}
          }
        }
      ],
      "created_at": ""
    }
  ]
}

WebSocket

WebSocket connection URL: ws://{host}:{port}/websocket

Request Parameters

Name	Location	Type	Required	Description
Authorization	query	string	Yes	none

Workflow

POST Search Workflow

POST /workflow/flows/search

Request Parameters

Name	Location	Type	Required	Description
name	body	string	No	Search name

Response

Field Name	Field Type	Description
id	string	Workflow ID
name	string	Workflow name
remark	string	Workflow description
enabled	boolean	Is workflow enabled
user_nickname	string	User name
created_at	number	Creation timestamp
updated_at	number	Update timestamp

Response Example

Success

{
  "data": {
    "id": "",
    "name": "",
    "remark": "",
    "enabled": false,
    "user_nickname": "",
    "created_at": 0,
    "updated_at": 0
  }
}

PUT Edit Workflow Information

PUT /workflow/flows/{flowId}

Request Parameters

Name	Location	Type	Required	Description
flowId	path	string	Yes	Workflow ID
name	body	string	Yes	Workflow name
remark	body	string	Yes	Workflow description

Response

None

POST Delete Workflow

POST /workflow/flows/batch-delete

Request Parameters

Name	Location	Type	Required	Description
workflow_id_list	body	array of strings	Yes	List of workflow IDs

Response

None

GET Enable Workflow

GET /workflow/flows/{flowId}/enable

Request Parameters

Name	Location	Type	Required	Description
flowId	path	string	Yes	Workflow ID

Response

None

GET Disable Workflow

GET /workflow/flows/{flowId}/disable

Request Parameters

Name	Location	Type	Required	Description
flowId	path	string	Yes	Workflow ID

Response

None

POST Search Workflow Logs

POST /workflow/flows/{flowId}/logs/search

Request Parameters

Name	Location	Type	Required	Description
flowId	path	string	Yes	Workflow ID
status	body	string	No	Status (SUCCESS / ERROR)

Response

Field Name	Field Type	Description
id	string	Log ID
start_time	number	Start timestamp
time_cost	number	Time cost (ms)
status	string	Status (SUCCESS / ERROR)

Response Example

Success

{
  "data": [
    {
      "id": "",
      "start_time": 0,
      "time_cost": 0,
      "status": "SUCCESS"
    }
  ]
}

GET Query Log Details

GET /workflow/flows/logs/{logId}

Request Parameters

Name	Location	Type	Required	Description
logId	path	string	Yes	Log ID

Response

Field Name	Field Type	Description
trace_info	array	Node trace information
trace_info.$	object	Node trace information item
trace_info.$.message_id	string	Message ID
trace_info.$.node_id	string	Node ID
trace_info.$.node_label	string	Node label
trace_info.$.status	string	Status (SUCCESS / ERROR)
trace_info.$.start_time	number	Node start timestamp
trace_info.$.time_cost	number	Node time cost (ms)
trace_info.$.error_message	string	Error message
trace_info.$.input	string	Input parameters (JSON format)
trace_info.$.output	string	Output (JSON format)

Response Example

Success

{
  "data": {
    "trace_info": [
      {
        "message_id": "",
        "node_id": "",
        "node_label": "",
        "status": "SUCCESS",
        "start_time": 0,
        "time_cost": 0,
        "error_message": "",
        "input": "",
        "output": ""
      }
    ]
  }
}

GET Retrieve Workflow Design

GET /workflow/flows/{flowId}/design?version={versionId}

Request Parameters

Name	Location	Type	Required	Description
flowId	path	string	Yes	Workflow ID
versionId	query	string	No	Version ID (if not provided, fetch the latest version)

Response

Field Name	Field Type	Description
id	string	Workflow ID
name	string	Workflow name
remark	string	Workflow description
enabled	boolean	Is workflow enabled
version	number	Workflow version
design_data	string	Workflow data (JSON format)

Response Example

Success

{
  "data": {
    "id": "",
    "name": "",
    "remark": "",
    "enabled": false,
    "version": 0,
    "design_data": ""
  }
}

POST Validate Workflow Design

POST /workflow/flows/design/validate

Request Parameters

Name	Location	Type	Required	Description
design_data	body	string	Yes	Workflow data (JSON format)

Response

None

POST Save Workflow Design

POST /workflow/flows/design

Request Parameters

Name	Location	Type	Required	Description
id	body	string	No	Workflow ID (if not provided, create new)
version	body	number	No	Current version
name	body	string	Yes	Workflow name
enabled	body	boolean	Yes	Enable workflow
remark	body	string	Yes	Workflow description
design_data	body	string	Yes	Workflow data (JSON format)

info

If id and version are not provided, a new workflow is created. Otherwise, the data for the workflow ID is updated. When a user creates a new workflow and saves it, the returned id and version should be stored. If the user clicks save multiple times on the same page, the id and version from the previous call should be used.

Response

Field Name	Field Type	Description
id	string	Workflow ID
version	number	Current version

Response Example

Success

{
  "data": {
    "id": "",
    "version": 0
  }
}

POST Test Entire Workflow

POST /workflow/flows/test

Request Parameters

Name	Location	Type	Required	Description
input	body	object	Yes	Input parameters
design_data	body	string	Yes	Workflow data (JSON format)

Response

Field Name	Field Type	Description
status	string	Status (SUCCESS / ERROR)
flow_id	string	Workflow ID
start_time	number	Start timestamp
time_cost	number	Time cost (ms)
trace_infos	array	Node trace information
trace_infos.$	object	Node trace information item
trace_infos.$.message_id	string	Message ID
trace_infos.$.node_id	string	Node ID
trace_infos.$.node_label	string	Node label
trace_infos.$.status	string	Status (SUCCESS / ERROR)
trace_infos.$.start_time	number	Node start timestamp
trace_infos.$.time_cost	number	Node time cost (ms)
trace_infos.$.error_message	string	Error message
trace_infos.$.input	string	Input parameters (JSON format)
trace_infos.$.output	string	Output (JSON format)

Response Example

Success

{
  "data": {
    "status": "SUCCESS",
    "flow_id": "",
    "start_time": 0,
    "time_cost": 0,
    "trace_infos": [
      {
        "message_id": "",
        "node_id": "",
        "node_label": "",
        "status": "SUCCESS",
        "start_time": 0,
        "time_cost": 0,
        "error_message": "",
        "input": "",
        "output": ""
      }
    ]
  }
}

POST Test Single Node in Workflow

POST /workflow/flows/node/test

Request Parameters

Name	Location	Type	Required	Description
node_config	body	string	Yes	Node data (JSON format)
input	body	object	Yes	Input parameters

Response

Field Name	Field Type	Description
message_id	string	Message ID
node_id	string	Node ID
node_label	string	Node label
status	string	Status (SUCCESS / ERROR)
start_time	number	Node start timestamp
time_cost	number	Node time cost (ms)
error_message	string	Error message
input	string	Input parameters (JSON format)
output	string	Output (JSON format)

Response Example

Success

{
  "data": {
    "message_id": "",
    "node_id": "",
    "node_label": "",
    "status": "SUCCESS",
    "start_time": 0,
    "time_cost": 0,
    "error_message": "",
    "input": "",
    "output": ""
  }
}

GET Retrieve All Workflow Groups

GET /workflow/components

Request Parameters

None

Response

Field Name	Field Type	Description
[section_name]	array	Components Group Name
[section_name].$	object	Component items
[section_name].$.name	string	Component name
[section_name].$.title	string	Component title
[section_name].$.data	string	Component definition data

Response Example

Success

{
  "data": {
    "entry": [
      {
        "name": "timer",
        "title": "timer",
        "data": ""
      },
      {
        "name": "direct",
        "title": "input",
        "data": ""
      },
      {
        "name": "eventListener",
        "title": "Event Listener",
        "data": ""
      }
    ],
    "control": [
      {
        "name": "choice",
        "title": "IF/ELSE",
        "data": ""
      }
    ],
    "action": [
      {
        "name": "serviceInvocation",
        "title": "Service Invocation",
        "data": ""
      },
      {
        "name": "entityAssigner",
        "title": "Entity Assigner",
        "data": ""
      }
    ],
    "external": [
      {
        "name": "email",
        "title": "Email",
        "data": ""
      },
      {
        "name": "webhook",
        "title": "Webhook",
        "data": ""
      }
    ]
  }
}

GET Retrieve Workflow Component Data

GET /workflow/components/{componentName}

Request Parameters

Name	Location	Type	Required	Description
componentName	path	string	Yes	Workflow component name

Response

Field Name	Field Type	Description
/	string	Workflow component data

Response Example

Success

{
  "component": {
      "name": "timer",
      "description": "Generate messages in specified intervals using java.util.Timer.",
      "scheme": "timer",
      "syntax":"timer:timerName"
      // ...
  },
  "componentProperties":{/*...*/},
  "headers":{
     "CamelTimerFiredTime":{/*...*/}
     // ...
  },
  "properties":{
     "timerName": { "index": 0, "kind": "path", "displayName": "Timer Name", "group": "consumer", "label": "", "required": true, "type": "string", "javaType": "java.lang.String", "deprecated": false, "deprecationNote": "", "autowired": false, "secret": false, "description": "The name of the timer" },
     // ...
  }
}

GET Retrieve Supported Scripting Languages

GET /workflow/components/languages

Request Parameters

None

Response

Field Name	Field Type	Description
code	array	Scripting languages
code.$	string	Language item
expression	array	Expression languages
expression.$	string	Language item

Response Example

Success

{
    "code": ["groovy","javascript","python","mvel"],
    "expression": ["groovy","javascript","python","mvel","jsonPath"]
}