API¶
For details of new APIs, log into the EnOS Management Console and click EnOS API > Release Notes from the navigation menu.
Connection Service¶
API | Description |
---|---|
Apply Certificate | Apply for a new certificate and bind it to a device |
Renew Certificate | Renew a certificate and bind it to a device |
Revoke Certificate | Revoke a certificate bound to a device |
List Certificate | List the certificates bound to a device |
Search Command | Query the details of the commands |
Replace Device | Replace the Device Key of a device without changing its asset ID (assetId) |
Asset Tree Service¶
API | Description |
---|---|
Create Asset Tree | Create an asset tree as well as its root node |
Create Asset Tree and Associate Asset | Create an asset tree and associate an existing asset as the root node of the asset tree |
Delete Asset Tree | Delete an asset tree |
Update Asset Tree | Update the asset tree information |
Alert Service¶
API | Description |
---|---|
Create Active Alerts in Batch | Create active alerts in batch |
Create History Alerts in Batch | Create history alerts in batch |
Close Active Alert | Close an active alert |
Search Alert Rule | Query alert rule under a specific organization |
Batch Update Active Alert Tags | Batch update the tags for the specified alerts |
Create Alert Rule | Create a new alert rule |
Update Alert Rule | Update an alert rule |
Delete Alert Rule | Delete all the rules under the organization as per the alert rule IDs |
Create Alert Content | Create a new alert content |
Update Alert Content | Update an alert content |
Delete Alert Content | Delete an alert content |
Create Alert Severity | Create a new alert severity |
Update Alert Severity | Update an alert severity |
Delete Alert Severity | Delete an alert severity |
Create Alert Type | Create a new alert type |
Update Alert Type | Update an alert type |
Delete Alert Type | Delete an alert type |
Create Active Alert | Create a new active alert |
Delete Active Alert | Delete a specified active alert |
Create History Alert | Create a new history alert |
TSDB Data Service¶
API | Description |
---|---|
Get Asset DI Data Duration | Get the duration of different status (DI) data of a specified device within a certain period |
All TSDB Data Service APIs | Added support of the POST method |
IAM Service¶
API | Description |
---|---|
Get Organization | Get the organization information |
Application Portal Service¶
API | Description |
---|---|
Get User’s Applications | Get a list of applications that the current user has permission to access through Access Token |
Authorize Asset | Authorize the new asset created on EnOS platform to the asset creator |
Check Asset Permission | Check if the current user has the access permission of the requested asset |
Choose Organization | Select the organization that the user needs to use after login |
Create Message | Create common messages and alert message on the Application Portal |
Get App Menu and Permission | Get the list of application menu and permission |
Get Assets by Application | Get all assets that the current user can access under a specified application |
Get Assets by Organization | Get all the assets that a specified user can access under a specified organization |
Get Asset Structure | Get the upstream organizational structure of the organizational structure in which the asset is located |
Get Colors of the Message Icon | Get the collection of colors that the message icon can be configured |
Get Manageable User List | Get a list of all users that can be managed under the current account |
Get Message Ringtones | Get the collection of ringtones that the message can be configured |
Get Organization List | List the organizations which the current user belongs according to the Access Token |
Get Organization User List | Authorize the application to get a list of all users under a specified organization without logging in the Application Portal |
Get Token Information | Get information about the currently logged-in user according to the Access Token |
Get User Information | Get the information of the current user |
Log In | Log in the account |
Log Out | Log out the account |
Refresh Access Token | Request a new Access Token with the Refresh Token |
Revoke Refresh Token | Revoke user’s Refresh Token |
Sync Asset | Synchronize assets with specified tags on the EnOS to the Application Portal |
Update Message | Update the status of the message |
Prediction Model Service¶
API | Description |
---|---|
Machine Learning Forecast | When an algorithm model is deployed successfully, get the prediction results of the deployed machine learning algorithm model. |
Dataflow Service¶
API | Description |
---|---|
Cancel Flow Instance | Cancel the running of a specific workflow instance. |
Create Directory | Create a directory of workflows. |
Delete Flow | Delete a specific workflow. |
Disable Flow | Disable the scheduling of a specific workflow. |
Enable Flow | Enable the scheduling of a specific workflow. |
Export Flow | Export the configuration of a workflow. |
Get Current Time | Get the current time of the server. |
Get Flow | Get the detailed information of a specific workflow. |
Get Flow Instance | Get the detailed information of a specific workflow instance. |
Get My Flow | Query the detailed information of workflows by specific conditions. |
Get Task Instance Log | Get the logs of a specific work instance. |
Get Time Zone | Get the time zone of the location of the server. |
Import Flow | Import workflow configuration to create a workflow and save the workflow in a specific directory. |
List Flow Instances | Query workflow instances by specific conditions. |
List Workflow Directories | List the workflow directory information (including sub-directories and workflow files) of the current OU. |
Load Flow For Edit | Load the information a specific workflow to a temporary workflow for editing. |
Save Flow | Save the configuration of the current workflow. |
Search Flow | Search workflows by specific conditions and list the workflows by pages. |
Trigger Flow | Trigger the scheduling of a specific workflow manually. |
Update And Trigger Flow | Trigger the scheduling of a specific workflow with new parameters (generating a workflow instance without changing the workflow information) |