Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

equipment

Update Equipment

put/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

Request body

custom_attributesCustomAttributes
latitudenumber nullable

latitude on the Earth

longitudenumber nullable

longitude on the Earth

namestring
type_id'acid_gas_removal' | 'desiccant_dehydrator' | 'ng_pneumatic_devices'
status'active' | 'inactive' | 'deprecated'
facility_idstring uuid

ID of the facility that the equipment belongs to

Example request

{
  "custom_attributes": {
    "attribute1": 12345,
    "attribute2": "value1"
  },
  "latitude": 51,
  "longitude": -114,
  "start_date": "min",
  "end_date": "max"
}

Response

successful operation

custom_attributesCustomAttributes
effective_datestring
idstring uuid
latitudenumber nullable

latitude on the Earth

longitudenumber nullable

longitude on the Earth

namestring

Example response

{
  "custom_attributes": {
    "attribute1": 12345,
    "attribute2": "value1"
  },
  "effective_date": "2022-01-01",
  "latitude": 51,
  "longitude": -114
}