Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

facilities

Update a Facility

put/app/v1/facilities/{facility_id}

Path parameters

facility_idstring uuid required

Id of facility

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
statusstring

Use id value of any index in GET /v1/facility_statuses

typestring

Use id value of any index in GET /v1/facility_types

Example request

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

Response

successful operation

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

latitude on the Earth

longitudenumber nullable

longitude on the Earth

namestring
statusstring

Use id value of any index in GET /v1/facility_statuses

typestring

Use id value of any index in GET /v1/facility_types

idstring uuid

Example response

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