APIs¶
In EnOS 2.1 Update Release, we added support to new APIs and API services.
Connection Service¶
The Connection Service has the following new APIs:
API |
Description |
|---|---|
Upload device attribute data, including file-type data |
|
Upload device event data, including file-type data |
|
Upload device measurement point data, including file-type data |
|
Download a file from a device |
|
Delete a file from a device |
|
Apply for a certificate and bind it to a device |
|
Update a certificate and bind it to a device |
|
Search for devices based on the search criteria such as the attributes and tags of a device |
TSDB Data Service¶
API Version Upgrade¶
Starting from EnOS 2.1 Update Release, the TSDB Data Service API is upgraded to V2.1 (V2.0 is still in service), which includes the following changes:
What’s new |
Before |
After |
Impact |
|---|---|---|---|
New Request Parameter |
N/A |
localTimeFormat |
All APIs |
New Request Parameter |
N/A |
itemFormat |
All APIs |
Method |
GET/POST |
POST |
All APIs |
Request/Response Parameter Name Change |
measurepoints |
pointIds |
All APIs |
Request/Response Parameter Name Change |
measurepointsWithLogic |
pointIdsWithLogic |
All APIs |
Request/Response Parameter Name Change |
measurepoint |
pointId |
All APIs |
Response Field Rename |
status |
code |
All APIs |
Return Code Rename |
Success |
OK |
All APIs |
New API¶
The following API is added to the TSDB Data Service API V2.1:
API |
Description |
|---|---|
Delete the latest data of the specified measurement points of specified devices |
TSDB Policy Service¶
The TSDB Policy Service has the following new APIs:
API |
Description |
|---|---|
Get the detailed information of a storage policy via the storage policy ID |
|
Update and save the configuration of a storage policy |
IAM Service¶
The IAM Service has the following new APIs:
API |
Description |
|---|---|
Log in to EnOS |
|
Get the session information after log in |
|
List all the organizations to which a user belongs |
Application Portal service¶
The Application Portal Service has the following new APIs:
API |
Description |
|---|---|
Get the list of users who have access permission to a specific asset |
|
Get the list of unresolved messages for an application |
|
Get the domain information of a user via the email address |
|
Get the information of the organization structure to which a user is assigned |
|
Log in to the Application Portal via authorization code |
Batch Processing Service¶
Starting from this release, the Dataflow Service is renamed to Batch Processing Service, and the service name in the request URL is changed from dataflow-batch-service to batch-processing-service. The API version is upgraded to V2.1, which includes the following changes.
What’s changed |
Before |
After |
Impact |
|---|---|---|---|
Response Field Rename |
status |
code |
All APIs |
Return Code Rename |
Success |
OK |
All APIs |
|
searchValue |
expression |
Get My Flow |
|
|
|
Search Flow, List Flow Instances |
Data Federation Service¶
The Data Federation Service is supported, with the following new APIs:
API Name |
Description |
|---|---|
Get the list of created channels (read and write) in the organization |
|
Read data by providing SQL query through the specified channel |
|
Get the data reading jobs or data writing jobs of a specified channel |
|
Get the detailed information of a data reading job or a data writing job |
|
Write message to data source through a specified channel |
|
Write file chunks to data source through a specified channel |
Streaming Service¶
The Streaming Service is supported, with the following new APIs:
API |
Description |
|---|---|
Get the intermediate state data of a specified operator (stage) in a stream processing job |
|
Delete the intermediate state data of a specified operator (stage) in a stream processing job |