APIs¶

In EnOS 2.2 Release, we added support for new APIs and API services.

Edge¶

Edge has the following new API:

API Name	Description
Get Latest Measurement Points	Get the real-time data of the model point of a single device.

The Connection Service has the following new APIs:

API	Description
Create Firmware File	Create firmware for a product.
Get Firmware	Get the firmware information based on its version.
List Device Current Firmware	List the firmware version of all devices that belong to a specific product.
Search Firmware	Get the information of all firmware in an OU.
Search Device Upgrade	Get the firmware information and upgrade status of a device.
Delete Firmware	Delete the specified firmware.
Create OTA Job	Create one or multiple OTA upgrade or firmware verification jobs.
Get OTA Job	Get the details of an OTA job.
Search OTA Job	Search for and get the details of OTA jobs based on the search criteria.
Search OTA Task	Search for and get the details of an OTA task that a device is executing based on the search criteria.
Start OTA Job	Start an OTA job.
Stop OTA Job	Stop an OTA job.
Delete OTA Job	Delete an OTA job.
Cancel OTA Task	Cancel an OTA task that a device is executing.
Retry OTA Task	Retry an OTA task.
Get Device Statistics	Get the device statistics of an organization or product.

The Asset Service has the following new API:

API	Description
Delete Logical Asset	Delete a specified logical asset.

The Alert Service has the following new API:

API	Description
Scroll History Alerts	Search for the past 3 months’ historical alerts, querying the next page according to the returned pageToken.

The Stream Processing Service has the following new APIs:

API Name	Description
Get Stage State	Get the intermediate state data of a specified operator (stage) in a stream processing pipeline.
Delete Stage State	Delete the intermediate state data of a specified operator (stage) in a stream processing pipeline.
List Pipelines	Get the list of stream processing pipelines in the organization by pages.
Operate Pipeline	Save, release, start, pause, and stop a stream processing pipeline.
Get Pipeline Offset and Lag	Get the Kafka Offset and Lag of a specific stream processing pipeline.

The Data Federation Service has the following new APIs:

API Name	Description
List Channels	Get the list of created channels (read and write) in the organization.
Read Data	Read data by providing SQL query through the specified channel.
List Jobs	Get the data reading jobs or data writing jobs of a specified channel.
Get Job Details	Get the detailed information of a data reading job or a data writing job.
Write Message	Write message to data source through a specified channel.
Write Chunk File	Write file chunks to data source through a specified channel.
Operate Channel	Start or stop a read channel or write channel.
Create Download Request	Create a file download task.
Get Download Status	Get the status of a file download task.
Cancel Download	Cancel a file download task.

The Application Portal Service has the following new APIs:

API	Description
Get Organization Language List	Get the list of languages available for an organization.
Get Structure Asset	Get all the assets that the user can access under an organization structure.
Get Organization Roles	Get all roles under an organization structure.
Get User Roles	Get all roles that are assigned to a user.

The Notification Management Service has the following new APIs:

API Name	Description
Send Template Mail	Sends a specific template message by specifying a mailbox in which custom parameters exist for the caller to replace
Send Template SMS	By specifying the SMS operator to send a specific template message, there are custom parameters in the template message that can be replaced by the caller
Search Send Result	Search this interface for the actual sent result of the message