Asset Service API Overview¶
An asset is an instance of a model. An asset can be a device, such as a meter. It can also be a physical or logical combination of a group of devices, such as a photovoltaic power plant, or an area where there are multiple assets.
Through the Asset Service API, asset administrators can create, manage, and update detailed information about assets within the organization, See API List。
Prerequisites¶
Ensure that you have obtained a service account, and the service account has the permission to call the Asset Service APIs. For more information, see Getting API Calling Permissions。
Ensure that you have read the limitations for logical assets. See Limitations.
API List
¶
You can learn from the table below which operations can be performed by calling the Asset Service API, the corresponding URLs for each operation, and whether they apply to EnOS Cloud and EnOS Edge.
Operation Name |
Description |
URL |
EnOS Cloud |
EnOS Edge |
---|---|---|---|---|
Get asset data by Asset ID |
/asset-service/v2.1/assets?action=get |
√ |
√ |
|
Update asset information |
/asset-service/v2.1/assets?action=update |
√ |
× |
|
Create a logical asset |
/asset-service/v2.1/logical-assets?action=create |
√ |
× |
|
Update all or selected details of a logical asset |
/asset-service/v2.1/logical-assets?action=update |
√ |
× |
|
Delete a specified logical asset |
/asset-service/v2.1/logical-assets?action=delete |
√ |
× |
SDK Samples¶
You can access the SDK samples for Asset Service on GitHub: