Query and Sort Asset Sub-Node

Last Updated on : 2023-06-20 15:22:52download

Get the sub-node assets under a specified asset. You can sort them by asset name or creation time.

API address

GET: /v1.1/iot-02/assets/{asset_id}/sub-assets

Request parameter

Parameter name	Type	IN	Required	Description
asset_id	String	uri	true	The asset ID.
page_no	Integer	query	true	The current page number.
page_size	Integer	query	true	The number of entries returned on each page.
sort_rule	String	query	true	The supported sorting rules are as follows: `assetsNameAsc`: Sort by asset name in ascending order. `assetsNameDesc`: Sort by asset name in descending order. `createTimeAsc`: Sort by creation time in ascending order. `createTimeDesc`: Sort by creation time in descending order.

Return parameter

Parameter name	Type	Description
result	AssetsPageListResponse	The returned result about assets.

Description of result

Parameter name	Type	Description
list	List	The list of asset results.
has_next	Boolean	Specifies whether there is a next page.

Description of list

Parameter name	Type	Description
asset_id	String	The asset ID.
parent_asset_id	String	The ID of the parent asset. The top-level ID is set to `-1`.
asset_name	String	The name of a specified asset.
asset_full_name	String	The full name of a specified asset.
level	Integer	The hierarchical level of a specified asset. The root node is set to `0`.

Request example

GET: /v1.1/iot-02/assets/abcd/sub-assets?page_no=1&page_size=20&sort_rule=assetNameAsc

Return example

{
    "list": [
        {
            "level": 0,
            "asset_id": "123",
            "asset_full_name": "123",
            "asset_name": "123",
            "parent_asset_id": "-1"
        }
    ],
    "has_next": false
}

Error code

For more information, see error code.

Prev DocTransfer Device

Next DocIndustry User Management