Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

equipment

Get an Equipment by ID

get/app/v1/equipment/{equipment_id}

Path parameters

equipment_idstring uuid required

Id of equipment

Query parameters

periodstring

year month (YYYYMM), defaulting to the current time, indicates which time period to return the attributes and custom attributes from

Response

successful operation

created_atstring date-time
updated_atstring date-time
created_bystring uuid
updated_bystring uuid
custom_attributesCustomAttributes
effective_datestring
idstring
latitudenumber nullable

latitude on the Earth

longitudenumber nullable

longitude on the Earth

namestring
status'active' | 'inactive' | 'deprecated'

Example response

{
  "custom_attributes": {
    "attribute1": 12345,
    "attribute2": "value1"
  },
  "effective_date": "2022-01-01",
  "facility": {
    "id": "1ca1117d-f2d6-47f5-ae3a-aa1025073717",
    "name": "Facility 1"
  },
  "latitude": 51,
  "longitude": -114
}