An asset zone is a pair of an asset and the details of the zone wherein the asset is contained.
Fields
| Tag | Data Type | Description |
| assetId | Integer | Internal identifier for asset contained in the zone. |
| zoneId | Integer | Internal identifier for zone containing the asset. |
| zoneName | Character (255) | The name of the zone containing the asset. |
Read
| API PATH: | /api/v2/assetZones |
| METHOD: | GET |
| PARAMETERS: | asset-id – Retrieves all matching records with the specified asset id (e.g. asset-id=1323556, all assets by default) zone-id – Retrieves all matching records with the specified zone id (e.g. zone-id=1329609, all zones by default) visibility-set-id – Retrieves all matching records whose assets belong to the set specified by the visibility set id (e.g. visibility-set-id=1726, all visibility sets by default) offset – Retrieves matching records after an offset value (e.g. offset=2, zero offset by default) limit – Retrieves a number of records per page specified by the value (e.g. limit=10, all records by default) |
| QUERY STRING EXAMPLES: | Get the asset zone with the specific asset id and zone id: ?asset-id=1323556&zone-id=1329609 Get the assets zones whose assets belong to the specified visibility set: ?visibility-set-id=1726 Get two asset zones of the current account with an offset of 1 : ?offset=1&limit=2 |
| EXAMPLE RESPONSE: |
[ { "assetId": 1323556, "zoneId": 1329609, "zoneName": "Restricted Area" } ]
|
API error calls
| ERROR MESSAGE | POSSIBLE CAUSES |
| POST is not supported. | POST method is not allowed |
| PUT is not supported. | PUT method is not allowed |
| DELETE is not supported. | DELETE method is not allowed |