Facilities
Facilities are discrete physical locations, such as refineries, manufacturing plants, or storage facilities, within which a single, or multiple, interconnected processes may be taking place.
Search facilities
Query parameters
periodstringOptional
year month (YYYYMM), defaulting to the current time, indicates which time period to return the attributes and custom attributes from
Body
all ofOptional
and
and
Responses
200
successful operation
application/json
Responseall of
post
POST /app/v1/facilities/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 200
{
"page": 0,
"page_size": 20,
"sort_by": "name",
"sort_direction": "desc",
"filter": {
"custom_attributes.hint": "View schema for all supported fields",
"custom_attributes.operator": "bob",
"name": {
"$like": "wind"
}
}
}
200
successful operation
{
"page_number": 0,
"page_size": 10,
"total_entries": 58,
"total_pages": 6,
"data": [
{
"created_at": "2025-08-19T00:27:55.442Z",
"updated_at": "2025-08-19T00:27:55.442Z",
"created_by": "123e4567-e89b-12d3-a456-426614174000",
"updated_by": "123e4567-e89b-12d3-a456-426614174000",
"custom_attributes": {
"attribute1": 12345,
"attribute2": "value1"
},
"latitude": 51,
"longitude": -114,
"name": "text",
"status": "text",
"type": "text",
"id": "123e4567-e89b-12d3-a456-426614174000"
}
]
}
Get a facility
Path parameters
facility_idstring · uuidRequiredExample:
Id of facility
748970de-fd1f-4494-ae3f-47cc21ff205f
Query parameters
periodstringOptional
year month (YYYYMM), defaulting to the current time, indicates which time period to return the attributes and custom attributes from
Responses
200
successful operation
application/json
Responseall of
get
GET /app/v1/facilities/{facility_id} HTTP/1.1
Host: api.validere.io
Accept: */*
200
successful operation
{
"created_at": "2025-08-19T00:27:55.442Z",
"updated_at": "2025-08-19T00:27:55.442Z",
"created_by": "123e4567-e89b-12d3-a456-426614174000",
"updated_by": "123e4567-e89b-12d3-a456-426614174000",
"custom_attributes": {
"attribute1": 12345,
"attribute2": "value1"
},
"latitude": 51,
"longitude": -114,
"name": "text",
"status": "text",
"type": "text",
"id": "123e4567-e89b-12d3-a456-426614174000",
"equipment": [
{
"custom_attributes": {
"attribute1": 12345,
"attribute2": "value1"
},
"effective_date": "2022-01-01",
"id": "123e4567-e89b-12d3-a456-426614174000",
"latitude": 51,
"longitude": -114,
"name": "text",
"type": {
"id": "text",
"name": "text"
}
}
]
}
Last updated