latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

devices

Update a Device

put/app/v1/devices/{device_id}

Path parameters

device_idstring uuid required

Id of device

Request body

attributesDeviceAttribute

Device Attributes

custom_attributesCustomAttributes
measurement_typesstring[]

Measurement types

namestring

name

status'active' | 'archived'

Example request

{
  "attributes": {
    "height": 10,
    "location": [
      43.65107,
      -79.347015
    ],
    "provider": "provider"
  },
  "custom_attributes": {
    "attribute1": 12345,
    "attribute2": "value1"
  },
  "start_date": "min",
  "end_date": "max"
}

Response

successful operation

created_atstring date-time
updated_atstring date-time
created_bystring uuid
updated_bystring uuid
attributesDeviceAttribute

Device Attributes

custom_attributesCustomAttributes
facility_idstring uuid

facility_id

idstring uuid
measurement_typesstring[]

measurement_types

namestring

Device name

status'active' | 'archived'
type_idstring

Device type

descriptionstring
unitsstring

Example response

{
  "attributes": {
    "height": 10,
    "location": [
      43.65107,
      -79.347015
    ],
    "provider": "provider"
  },
  "custom_attributes": {
    "attribute1": 12345,
    "attribute2": "value1"
  },
  "facility": {
    "id": "1ca1117d-f2d6-47f5-ae3a-aa1025073717",
    "name": "Facility 1"
  },
  "measurement_types": [
    "volume"
  ],
  "measurement_series": [
    {
      "measurement_type": "volume",
      "unit": "bbl"
    }
  ]
}