New APIs¶

Note

APIs marked with “(Preview)” are selective opt-in APIs that are ready for you to test and evaluate but not recommended for production use. Contact your sales representative if you are interested in a Preview API.

In EnOS 2.3 Release, we added support to the following new APIs and API services.

EnOS General Service¶

Here are the API updates of services that support both EnOS Edge and EnOS Cloud. “√” and “×” refers to whether EnOS Cloud/EnOS Edge supports or does not support the API respectively.

Alert Service¶

API Name	Description	EnOS Cloud	EnOS Edge
Create Alert	Create an alert	√	×
Batch Create Alert	Batch create alerts	√	×
Search Alerts	Query active and historical alerts, where the page of the returned results does not have to be in order	√	×
Scroll Alerts	Query active and historical alerts	√	×
Close Alert	Closes the active alert and stores as a history alert	√	×
Update Alert Tags	Update history and active alert tags	√	×
Batch Update Alert Tags	Batch update the tags for the specified history and active alerts	√	×

TSDB Policy Service V2.1¶

API Name	Description	EnOS Cloud	EnOS Edge
Get Unformatted Policy	Get information of organization’s unformatted storage policy, including storage policy ID, update time and retention	√	×
Update Unformatted Policy	Update the data storage time of organization’s unformatted storage polic	√	×

TSDB Data Service V2.1¶

API Name	Description	EnOS Cloud	EnOS Edge
Get Asset Unformatted Data	Get unformatted original data of specified measurement point of specified devices within a certain period.	√	×

Asset Service¶

API Name	Description	EnOS Cloud	EnOS Edge
Create Logical Asset (Preview)	Create a logical asset	√	×
Update Logical Asset (Preview)	Update all or selected details of a logical asset	√	×

Data Catalog Service¶

API Name	Description	EnOS Cloud	EnOS Edge
Search Data Objects	Query data objects under a specified data type. Supports filtering data by data objects attribute value, associated tags and tag attributes, and associated business terms.	√	×
View Data Objects Details (Searching by GUID)	Get the details of data objects according to GUID. Data details include basic information, associated data objects, associated tags and tag attributes, and associated business terms.	√	×
View Data Objects Details (Filtering by attributes)	Get the details of data objects according to data objects attributes. Data details include basic information, associated data objects, associated tags and tag attributes, and associated business terms.	√	×
Import Data	Common interface for importing entities. Supports FileSet, Measure and custom data type.	√	×

Business Process Management Service¶

API Name	Description	EnOS Cloud	EnOS Edge
Get Process View Columns	Get the information of process view columns	√	×
Query Process Instance By View	Query the list of process instance by process view	√	×
Claim and Complete Task	Claim and submit the task form to complete the task	√	×

EnOS Edge Specific Service¶

Here are the API updates of EnOS Edge specific services.

No update in this release.