Cloud Services API ReferenceIndustrial ScenariosIndustry Basic ServiceIndustry Asset ManagementQuery Cross-Level Sub-Assets

Query Cross-Level Sub-Assets

Last Updated on : 2023-07-19 09:51:52download

Query the cross-level sub-assets on pages.
If the asset ID (asset_id) has a value, the asset ID is used as the root node, and you can query the information about all sub-assets on pages.
If the asset name (asset_name) has a value, you can perform a fuzzy query on the asset name, and query the information about all sub-assets on pages.
If neither value is passed, you can query the information about all sub-assets under the specified project.

API address

POST: /v1.1/iot-02/cross-level-sub-assets

Request parameter

Description of body

Parameter name	Type	Required	Description
asset_id	String	false	The asset ID.
asset_name	String	false	The asset name.
last_row_key	String	false	The row key of the last entry on each page.
page_size	Integer	true	The number of items returned on each page.
level	Integer	false	The level of the specified asset.

Return parameter

Parameter name	Type	Description
result	HighwayAssetsCrossLevelPageResponse	The returned result of querying the sub-assets.

Description of result

Parameter name	Type	Description
has_next	Boolean	Specifies whether to return the next page.
count	Integer	The total number of returned entries.
last_row_key	String	The row key of the last entry.
page_size	Integer	The number of items returned on each page.
list	List	The list of asset results.

Description of list

Parameter name	Type	Description
level	Integer	The hierarchical level of the specified asset. The root node is set to `0`.
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 asset name.
asset_full_name	String	The full name of the specified asset.

Request example

POST: /v1.1/iot-02/cross-level-sub-assets

{
  "asset_id": "137493****62112",
  "asset_name": "Asset",
  "last_row_key": "13750****74592",
  "page_size": 10,
  "level": 0
}

Return example

{
    "last_row_key": "13750****74592",
    "count": 3,
    "list": [
        {
            "level": 0,
            "asset_id": "137493****62112",
            "asset_full_name": "Asset AAA",
            "asset_name": "Asset A",
            "parent_asset_id": "-1"
        },
        {
            "level": 0,
            "asset_id": "13750****74592",
            "asset_full_name": "Asset BBB",
            "asset_name": "Asset B",
            "parent_asset_id": "137493****62112"
        }
    ],
    "t": 1616663281459,
    "success": true,
    "has_next": "false",
    "page_size": 10
}

Error code

For more information, see error code.

Prev DocRevoke Asset Permissions from a User

Next DocQuery Authorized User List