Connection Service Overview¶
The connection service APIs provide management operations for products, devices, and commands. For more information on device management in EnOS™, see Device Connectivity & Management Service.
The APIs in the connection service are some of the APIs EnOS provides that cover the core business processes of the system. For more information on EnOS APIs and the different APIs that EnOS provides, see About EnOS API.
For more information on how to invoke EnOS APIs, see Get Started with EnOS API.
Refer to the table below for the list of APIs, and whether they can be used by EnOS™ Cloud and EnOS™ Edge.
Product¶
Operation Name |
Description |
EnOS Cloud |
EnOS Edge |
---|---|---|---|
Create a product |
√ |
× |
|
Delete a product |
√ |
× |
|
Get the details of a product via its |
√ |
× |
|
Search for products based on the search criteria |
√ |
× |
|
Update a product |
√ |
× |
Device¶
Operation Name |
Description |
EnOS Cloud |
EnOS Edge |
---|---|---|---|
Create a device |
√ |
× |
|
Batch create devices |
√ |
× |
|
Delete a device |
√ |
× |
|
Disable a device |
√ |
× |
|
Activate a device |
√ |
× |
|
Get the information of a device |
√ |
√ |
|
Replace the |
√ |
× |
|
Search for devices based on the search criteria |
√ |
× |
|
Update a device |
√ |
× |
Certificate¶
Operation Name |
Description |
EnOS Cloud |
EnOS Edge |
---|---|---|---|
Apply for a certificate and bind it to a device |
√ |
× |
|
Update a certificate and bind it to a device |
√ |
× |
|
Revoke a certificate bound to a device |
√ |
× |
|
List the certificates bound to a device |
√ |
× |
Gateway and Sub-Device¶
Operation Name |
Description |
EnOS Cloud |
EnOS Edge |
---|---|---|---|
Add new sub-devices to the gateway device |
√ |
× |
|
Get the gateway information based on the specified sub-device |
√ |
× |
|
Remove sub-devices from the gateway |
√ |
× |
|
Search for sub-devices under the specified gateway |
√ |
× |
Device Data¶
Operation Name |
Description |
EnOS Cloud |
EnOS Edge |
---|---|---|---|
Cancel cached commands |
√ |
× |
|
Get the details of a command |
√ |
× |
|
Get the details of an event via |
√ |
× |
|
Service invocation interface for the device |
√ |
× |
|
Search for commands |
√ |
× |
|
Search for events based on the search criteria |
√ |
× |
|
Measurepoint setting interface |
√ |
√ |
|
Get the information of a file |
√ |
× |
|
Download a file from a device |
√ |
× |
|
Delete a file from a device |
√ |
× |
HTTP Message Integration¶
Operation Name |
Description |
EnOS Cloud |
EnOS Edge |
---|---|---|---|
Upload the attribute data of a device, including file-type data |
√ |
× |
|
Upload the event data of a device, including file-type data |
√ |
× |
|
Upload the measurement point data of a device, including file-type data |
√ |
× |
Firmware Management¶
Operation Name |
Description |
EnOS Cloud |
EnOS Edge |
---|---|---|---|
Create a firmware file for a product. |
√ |
× |
|
Get the file of the specified firmware. |
√ |
× |
|
List the firmware versions of all devices under the specified product. |
√ |
× |
|
Search for firmware files under an OU based on the search criteria. |
√ |
× |
|
Search for the firmware and upgrade status of the device based on the search criteria. |
√ |
× |
|
Delete a firmware. |
√ |
× |
Firmware OTA Upgrade Management¶
Operation Name |
Description |
EnOS Cloud |
EnOS Edge |
---|---|---|---|
Create an OTA job for batch verification or upgrading. |
√ |
× |
|
Get the details of an OTA job. |
√ |
× |
|
Search for OTA jobs based on the search criteria. |
√ |
× |
|
Search for OTA tasks based on the search criteria. |
√ |
× |
|
Start an OTA job. |
√ |
× |
|
Stop an OTA job. |
√ |
× |
|
Delete an OTA job. |
√ |
× |
|
Cancel OTA tasks under the specified OTA job. |
√ |
× |
|
Retry OTA tasks under the specified OTA job. |
√ |
× |