Changed APIs¶
EnOS 2.4 introduces the following API behavioral changes.
EnOS General APIs¶
The limitation changes of some of the general APIs are listed in the below.
Service / Function |
Before |
After |
Impact |
---|---|---|---|
Model Service |
Attributes with |
Attributes with |
None |
Connection Service > Product |
|
|
None |
Connection Service > Firmware Management |
|
|
None |
Asset Tree Service > Asset Tree |
|
|
None |
The required authorization and operation permission changes of some of the general APIs are listed in the below.
API Name |
Before |
After |
Impact |
EnOS Cloud |
EnOS Edge |
---|---|---|---|---|---|
Model Service > Update Thing Model |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > Create Product |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > Delete Product |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > Update Product |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > Apply Certificate |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > Renew Certificate |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > Revoke Certificate |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > List Certificate |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > Create Firmware File |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > Delete Firmware |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > Create OTA Job |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
Connection Service > Delete OTA Job |
|
|
None. The authorized service accounts have been updated synchronously |
√ |
× |
The applicability changes for EnOS Edge of some general APIs are listed in the below.
Service / Function |
API Name |
Before |
After |
Impact |
---|---|---|---|---|
Connection Service > Device Data |
Not applicable to EnOS Edge |
Supports invoking the API to get latest measurement points uploaded by EnOS Edge |
None |
|
Connection Service > Device |
Not applicable to EnOS Edge |
Supports invoking the API to search the information of EnOS Edge devices |
EnOS Edge simplifies some of the request and return parameters. For more information, see Search Device |
|
Connection Service > HTTP Message Integration |
Not applicable to EnOS Edge |
Supports invoking the API to upload measurement points of EnOS Edge devices, except for file-type data |
None |
|
Alert Engine Service > Alert Content |
Applicable to EnOS Edge,but does not support EnOS Edge to perform OU verification |
Supports EnOS Edge to perform OU verification |
None |
|
Alert Engine Service > Alert Rule |
Not applicable to EnOS Edge |
Supports invoking the API to query alert rules configured for devices of EnOS Edge |
None |
|
Alert Engine Service > Alert Record > History & Active Alert Records |
Not applicable to EnOS Edge |
Supports invoking APIs to (batch) create and search the history and active alert records of devices of EnOS Edge, or closing an active alert |
None |
|
Alert Engine Service > Alert Record > Alert Tags |
Not applicable to EnOS Edge |
Supports invoking APIs to (batch) updating history and active alert tags of devices of EnOS Edge |
None |
Model Service¶
API Name |
Description |
EnOS Cloud |
EnOS Edge |
---|---|---|---|
Added new parameters |
√ |
× |
|
Added new parameters |
√ |
× |
Connection Service¶
API Name |
Description |
EnOS Cloud |
EnOS Edge |
---|---|---|---|
Supports fuzzy query of |
√ |
× |
Asset Tree Service¶
API Name |
Description |
EnOS Cloud |
EnOS Edge |
---|---|---|---|
Add new request parameter |
√ |
× |
Alert Engine Service¶
API Name |
Description |
---|---|
EnOS Edge supports OU verification for this API. |