Query Assets by Criteria

Last Updated on : 2023-06-21 07:12:58download

Query the information about assets by asset ID and asset name.

API address

GET: /v1.0/iot-03/assets

Request parameter

Parameter name Type IN Required Description
req AssetQueryReq query false The criteria to query assets.

Description of req

Parameter name Type IN Required Description
asset_id String false The ID of a specified asset.
asset_name String false The asset name.
page_size Integer false The number of items returned on each page.
last_row_key String false A collection of asset IDs.

Return parameter

Parameter name Type Description
result CursorPage The returned results on pages.

Description of result

Parameter name Type Description
last_row_key String A collection of asset IDs.
list List
has_more Boolean Specifies whether to return the next page.

Description of list

Parameter name Type Description
asset_id String The ID of a specified asset.
asset_name String The asset name.
asset_full_name String The full name of a specified asset.
parent_asset_id String The ID of the parent asset.
asset_image String The image of a specified asset, with no more than 200 characters.
asset_type String The type of a specified asset. Valid values: park: a park. building: a building. floor: a floor. room: a space.

Request example

GET: /v1.0/iot-03/assets

Return example

{ "result": { "last_row_key": "1410069679258497024", "list": [ { "asset_id": "141006967925849****", "asset_full_name": "Hangzhou Grand Center", "asset_name": "Meeting Room 1", "parent_asset_id": "141006947442969****" } ], "has_more": false }, "t": 1625210851076, "success": true }

Error code

For more information, see error code.