Asset Tree Service Overview¶
The asset tree service APIs provide management operations for asset trees, asset nodes, and asset paths. For more information on asset trees, see Asset Tree Overview.
The APIs in the asset tree 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.
Prerequisites¶
Ensure that you have read the limitations for asset trees. See Limitations.
API List¶
Refer to the table below for the list of APIs, and whether they can be used by EnOS Cloud and EnOS Edge.
Asset Tree¶
| Operation Name | Description | URL | EnOS Cloud | EnOS Edge |
|---|---|---|---|---|
| Create Asset Tree | Create an asset tree as well as its root node | /asset-tree-service/v2.1/asset-trees?action=create | √ | × |
| Create Asset Tree and Associate Asset | Create an asset tree and link an existing asset as the root node of the asset tree | /asset-tree-service/v2.1/asset-trees?action=associate | √ | × |
| Delete Asset Tree | Delete an asset tree | /asset-tree-service/v2.1/asset-trees?action=delete | √ | × |
| Get Asset Tree | Get the details of an asset tree | /asset-tree-service/v2.1/asset-trees?action=get | √ | √ |
| Search Asset Tree | Search for asset trees based on the search criteria | /asset-tree-service/v2.1/asset-trees?action=search | √ | √ |
| Update Asset Tree | Update the information of an asset tree | /asset-tree-service/v2.1/asset-trees?action=update | √ | × |
Asset Tree Node¶
| Operation Name | Description | URL | EnOS Cloud | EnOS Edge |
|---|---|---|---|---|
| Associate Asset | Link an existing asset to an asset tree | /asset-tree-service/v2.1/asset-nodes?action=associateAsset | √ | × |
| Batch Associate Asset | Batch link existing assets to an asset tree | /asset-tree-service/v2.1/asset-nodes?action=associateAssetBatch | √ | × |
| Create and Associate Asset | Create an asset and link it to an asset tree | /asset-tree-service/v2.1/asset-nodes?action=createAsset | √ | × |
| Move Asset Node | Move an asset node and its descendant nodes to a specified location | /asset-tree-service/v2.1/asset-nodes?action=move | √ | × |
| Delete Asset Node | Remove an asset from an asset tree | /asset-tree-service/v2.1/asset-nodes?action=delete | √ | × |
| Get Asset Trees | Get the details of one or multiple asset trees based on a set of assetIds |
/asset-tree-service/v2.1/asset-nodes?action=getAssetTree | √ | √ |
| Search Asset Node | Search for assets based on the search criteria | /asset-tree-service/v2.1/asset-nodes?action=searchAsset | √ | √ |
| Search Related Asset Node | Search for assets under the specified asset tree based on the relationship with a known asset | /asset-tree-service/v2.1/asset-nodes?action=searchRelatedAsset | √ | √ |
| Search Asset Path | Search for paths on the asset tree | /asset-tree-service/v2.1/asset-paths?action=search | √ | √ |
API Editions¶
The following table lists the API services included in Asset Tree Service Enterprise and Lightweight editions.
| Operation Name | Enterprise | Lightweight |
|---|---|---|
| Associate Asset | √ | √ |
| Batch Associate Asset | √ | √ |
| Create and Associate Asset | √ | √ |
| Move Asset Node | √ | √ |
| Delete Asset Node | √ | √ |
| Get Asset Trees | √ | √ |
| Search Asset Node | √ | √ |
| Search Related Asset Node | √ | √ |
| Search Asset Path | √ | √ |