Get List of Assets

This API provides a list of assets deployed within a bounding box (bbox) that you define with GPS coordinates.

METHOD GET
Request URI {{metadataurl}}/v2/assets/search?bbox=<long,lat>&page=<int>&size=<int>&q=assetType:<assetType1>&eventType=<eventType1>&mediaType=<mediaType1>
Sample Request URI {{metadataurl}}/v2/assets/search?bbox=32.715675:-117.161230,32.708498:-117.151681&page=0&size=50&q=assetType:CAMERA&eventType=PKIN

Query Parameters

Parameter Description Required? Filter Values
bbox The bounded area for your search; establishes the periphery of a searchable area for assets and nodes, identified by GPS coordinates. Cities: Yes

Enterprises: No

bbox=x1:y1, x2:y2

Replace x1:y1, x2:y2 with GPS coordinates, similar to the following:

32.715675:-117.161230,32.708498:-117.151681

You can use Google Maps to obtain the latitude and longitude. To locate GPS coordinates for the area and identify the boundaries, place the cursor in the upper left location of the area, then right-click and select What’s here? to obtain the first set of coordinates. Right-click on the lower-right location and repeat this procedure to obtain the second set of coordinates.

q Identifies a "type" query. No Query to search by assetType, mediaType, or eventTypes.
assetType Filter by type of asset.
Note: CAMERA is the only sensor that will generate eventTypes and mediaType.
No See the enumeration codes for assetType in the Glossary for Intelligent Enterprises.
mediaType Filter by type of media.
Note: Get Media only works when you have access to the Situational Awareness API.
No See the enumeration codes for mediaType in the Glossary for Intelligent Enterprises.
eventTypes Filter by type of event. No See the enumeration codes for eventType in the Glossary for Intelligent Enterprises.
size Maximum number of records to return per page; if none specified, the default value of 2 is used automatically. No Numerical value, such as 20.
page Indicates the page number; default is 0. No Numerical value, such as 1.

Response Parameters

Parameter Data Type Description
assetUid String A unique identifier established by a customer or external resource. For example, CAMERA-STG-HYP1042-CAM-L to identify a camera.
parentAssetUid string A unique identifier assigned to the asset at the top of a hierarchical set of assets, in other words, the parent of a child asset. For example, a node is a parent asset, comprising child assets such as cameras or microphones.
eventTypes String

The event type that was recorded. In the sample response data, the camera on the specified node is collecting data on parking instances (vehicle in, vehicle out) and traffic flow in the parking area.

See the enumeration codes for eventTypes in the Glossary for Intelligent Enterprises.
mediaType String

Media output. In the sample response data, the camera on the specified node is collecting video to record when vehicles enter and exit a parking space.

See the enumeration codes for mediaType in the Glossary for Intelligent Enterprises.
assetType String

Type of asset that records the events.

See the enumeration codes for assetType in the Glossary for Intelligent Enterprises.
coordinates String The GPS coordinates (latitude, longitude) for the referenced asset (identified by assetUid), such as 32.711653,-117.157314 to identify where the camera is installed.

Sample Response

{
  "content": [
    {
      "assetUid": "STG-HYP1087-170",
      "parentAssetUid": "POLE-HYP1087-43",
      "eventTypes": [
        "TFEVT",
        "PKIN",
        "PEDEVT",
        "PKOUT"
      ],
      "mediaType": "IMAGE",
      "assetType": "CAMERA",
      "coordinates": "30.328126000000001:-81.6596200000000039"
    },
  ],
  "last": true,
  "totalElements": 6,
  "totalPages": 1,
  "numberOfElements": 6,
  "first": true,
  "sort": null,
  "size": 50,
  "number": 0
}