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 Product	Create a product	√	×
Delete Product	Delete a product	√	×
Get Product	Get the details of a product via its `productKey`	√	×
Search Product	Search for products based on the search criteria	√	×
Update Product	Update a product	√	×

Device¶

Operation Name	Description	EnOS Cloud	EnOS Edge
Create Device	Create a device	√	×
Batch Create Devices	Batch create devices	√	×
Delete Device	Delete a device	√	×
Disable Device	Disable a device	√	×
Enable Device	Activate a device	√	×
Get Device	Get the information of a device	√	×
Replace Device	Replace the `deviceKey` of a device without changing its `assetId`	√	×
Search Device	Search for devices based on the search criteria	√	×
Update Device	Update a device	√	×

Certificate¶

Operation Name	Description	EnOS Cloud	EnOS Edge
Apply Certificate	Apply for a certificate and bind it to a device	√	×
Renew Certificate	Update 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	√	×

Gateway and Sub-Device¶

Operation Name	Description	EnOS Cloud	EnOS Edge
Add Sub-Device	Add new sub-devices to the gateway device	√	×
Get Gateway	Get the gateway information based on the specified sub-device	√	×
Remove Sub-Device	Remove sub-devices from the gateway	√	×
Search Sub-Device	Search for sub-devices under the specified gateway	√	×

Device Data¶

Operation Name	Description	EnOS Cloud	EnOS Edge
Cancel Command	Cancel cached commands	√	×
Get Command	Get the details of a command	√	×
Get Event	Get the details of an event via `eventId`	√	×
Invoke Service	Service invocation for the device	√	×
Search Command	Search for commands	√	×
Search Event	Search for events based on the search criteria	√	×
Set Measurement Point	Measurement point setting for the device	√	√
Delete File	Delete a file from a device	√	×
Download File	Download a file from a device	√	×

HTTP Message Integration¶

Operation Name	Description	EnOS Cloud	EnOS Edge
Upload Attribute	Upload the attribute data of a device, including file-type data	√	×
Upload Event	Upload the event data of a device, including file-type data	√	×
Upload Measurement Point	Upload the measurement point data of a device, including file-type data	√	×

Firmware Management¶

Operation Name	Description	EnOS Cloud	EnOS Edge
Create Firmware File	Create a firmware file for a product	√	×
Get Firmware File	Get the file of the specified firmware	√	×
List Device Current Firmware	List the firmware versions of all devices under the specified product	√	×
Search Firmware File	Search for firmware files under an OU based on the search criteria	√	×
Search Device Upgrade	Search for the firmware and upgrade status of the device based on the search criteria	√	×
Delete Firmware	Delete a firmware	√	×

Firmware OTA Upgrade Management¶

Operation Name	Description	EnOS Cloud	EnOS Edge
Create OTA Job	Create an OTA job for batch verification or upgrading	√	×
Get OTA Job	Get the details of an OTA job	√	×
Search OTA Job	Search for OTA jobs based on the search criteria	√	×
Search OTA Task	Search for OTA tasks 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 OTA tasks under the specified OTA job	√	×
Retry OTA Task	Retry OTA tasks under the specified OTA job	√	×