Get Asset Details

This API returns details on a particular asset.

METHOD	GET
Request URI	<production url>/v1/assets/{id}
Sample Request URI	<production url/v1/assets/1000000018

Query Parameters

Parameter	Description	Required?	Filter Values
id	GE identifier for an asset.	Yes	1000000018

Response Parameters

Parameter	Data Type	Required?	Description
coordinates	String	Yes	The GPS coordinates (latitude, longitude) for the referenced device (identified by device-id), such as 32.711653,-117.157314 to identify where the camera is installed.
status	String	Yes	Current status of the sensor: ONLINE Collecting data. OFFLINE Not collecting data. UNKNOWN Unknown status.
description	String	No	General description of the location, such as cross streets.
properties	String	No	Properties of the sensor. These can include the CAMERA FRAME RATE, TEMPERATURE, SIGNAL, AND SPACE)
_links	Object	Yes	A collection of hyperlinks to templates, for executing additional operations. self URL for this API. search-media Additional query parameters: media-type – IMAGE, AUDIO, VIDEO, OTHERS start-ts – Start time recorded in EPOCH format. end-ts – End time recorded in EPOCH format. page – Pageable results, based on the search filter. size – Maximum number of records per page. search-events Additional query parameters: event-type – PKIN, PKOUT, SFIN, SFOUT, TFEVT, ENCHG, LIGHT_LEVEL, OCCUPANCY, TEMP start-ts – Start time recorded in EPOCH format. end-ts – End time recorded in EPOCH format. size – Maximum number of records per page. live-events URL to a WebSocket. You must use a WebSocket client to retrieve this data.
device-id	String	Yes	A unique identifier established by a customer or external resource. For example, HYP1040-75 to identify a camera.
event-type	String	Yes	Event type recorded. PKIN Vehicles entering location. PKOUT Vehicles exiting location. SFIN Pedestrians entering location. SFOUT Pedestrians exiting location. TFEVT Traffic event at location. ENCHG Environmental change at location. LIGHT_LEVEL Asset reports illuminance sensor events. OCCUPANCY Asset reports occupancy sensor events. TEMP Asset reports temperature sensor events.
media-type	String	Yes	Media output. IMAGE JPG, PNG, or GIF formats. VIDEO MP4 format. AUDIO MP3 or WAV format. OTHERS Non-standard formats.
device-type	String	Yes	Type of device that is recording the events. NODE Parent asset. CAMERA Camera installed within the bounding box. MIC Audio device installed within the boundaries. ENV Environmental sensor installed within the boundaries. OTHERS Non-standard or unknown devices within the boundaries.
embedded	Object	Yes	List of locations, with coordinates, links, location-uid, and location-type.
locations	Array	Yes	Identifies within the brackets ([ ]) each location monitored by the device (device-id). location-uid A unique identifier established by a customer or external resource for a specific location within the monitored area. For example, a12835g2-0b4a-4019-b9dc-886439413e76. coordinates GPS coordinates identifying the location. Four coordinates should be provided for each location-uid. location-type Indicates the type of specific location, as follows: PARKING – Parking location. PARKING_SPOT – Demarcated parking location. PARKING_ZONE – Non-demarcated parking location. CROSSWALK – Pedestrian crosswalk. TRAFFIC_LANE – Monitored strip of road where vehicles are moving. RETAIL-STORE – Retail store. OTHERS – Non-standard location types.

Sample Response

{
  "coordinates": {
    "P1": "32.711653,-117.157314"
  },
  "description": "simulator camera for parking",
  "properties": {},
  "_links": {
    "self": {
      "href": "http://ie-traffic-dev.run.aws-usw02-pr.ice.predix.io/v1/assets/1000000018"
    },
    "search-media": {
      "href": "http://ie-traffic-dev.run.aws-usw02-pr.ice.predix.io/v1/assets/1000000018/media{?media-types,start-ts,end-ts,page,size,locationId}",
      "templated": true
    },
    "search-events": {
      "href": "http://ie-traffic-dev.run.aws-usw02-pr.ice.predix.io/v1/assets/1000000018/events{?event-types,start-ts,end-ts,size}",
      "templated": true
    },
    "live-events": {
      "href": "http://ie-traffic-dev.run.aws-usw02-pr.ice.predix.io/v1/assets/1000000018/live-events{?event-types}",
      "templated": true
    }
  },
  "device-id": "HYP1040-75",
  "event-type": "PKOUT;TFEVT;PKIN",
  "media-type": "IMAGE",
  "device-type": "DATASIM",
  "status": "OTHER",
  "_embedded": {
    "container": null,
    "locations": [
      {
        "coordinates": {
          "P1": "32.711637,-117.15732968838816",
          "P2": "32.711637100678395,-117.15736341303291",
          "P3": "32.711734,-117.15736427535526",
          "P4": "32.711733,-117.15733055071051"
        },
        "_links": {
          "self": {
            "href": "http://ie-traffic-dev.run.aws-usw02-pr.ice.predix.io/v1/locations/1000000048"
          }
        },
        "location-uid": "158-parkingspot",
        "location-type": "PARKING_SPOT"
      },
      {
        "coordinates": {
          "P1": "32.711734697964815,-117.1573294130409",
          "P2": "32.711736,-117.15736248188104",
          "P3": "32.711858,-117.15736455072118",
          "P4": "32.711859,-117.1573304130409"
        },
        "_links": {
          "self": {
            "href": "http://ie-traffic-dev.run.aws-usw02-pr.ice.predix.io/v1/locations/1000000047"
          }
        },
        "location-uid": "157-parkingspot",
        "location-type": "PARKING_SPOT"
      }
    ],
    "assets": []
  }
}