Flows
Flows model the concept of interconnectivity between assets, such as Equipment, Facilities, or other pre-existing Flows.
Search flows
Get a flow
Path parameters
idstring · uuidRequired
Flow ID
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
A successful operation
application/json
Responseall of
and
and
and
one ofOptional
or
or
or
get
GET /app/v1/flows/{id} HTTP/1.1
Host: api.validere.io
Accept: */*
200
A successful operation
{
"name": "text",
"type": "text",
"status": "active",
"product_category": "text",
"product_type": "text",
"custom_attributes": {
"attribute1": 12345,
"attribute2": "value1"
},
"upstream_flow_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"downstream_flow_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"upstream_flows_count": 1,
"downstream_flows_count": 1,
"upstream_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"downstream_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"upstream_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"downstream_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"associated_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"associated_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-08-19T00:19:43.005Z",
"updated_at": "2025-08-19T00:19:43.005Z",
"created_by": "123e4567-e89b-12d3-a456-426614174000",
"updated_by": "123e4567-e89b-12d3-a456-426614174000",
"upstream_flows": [
{
"name": "text",
"type": "text",
"status": "active",
"product_category": "text",
"product_type": "text",
"custom_attributes": {
"attribute1": 12345,
"attribute2": "value1"
},
"upstream_flow_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"downstream_flow_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"upstream_flows_count": 1,
"downstream_flows_count": 1,
"upstream_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"downstream_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"upstream_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"downstream_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"associated_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"associated_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-08-19T00:19:43.005Z",
"updated_at": "2025-08-19T00:19:43.005Z",
"created_by": "123e4567-e89b-12d3-a456-426614174000",
"updated_by": "123e4567-e89b-12d3-a456-426614174000"
}
],
"downstream_flows": [
{
"name": "text",
"type": "text",
"status": "active",
"product_category": "text",
"product_type": "text",
"custom_attributes": {
"attribute1": 12345,
"attribute2": "value1"
},
"upstream_flow_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"downstream_flow_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"upstream_flows_count": 1,
"downstream_flows_count": 1,
"upstream_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"downstream_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"upstream_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"downstream_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"associated_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"associated_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-08-19T00:19:43.005Z",
"updated_at": "2025-08-19T00:19:43.005Z",
"created_by": "123e4567-e89b-12d3-a456-426614174000",
"updated_by": "123e4567-e89b-12d3-a456-426614174000"
}
],
"upstream_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"
}
},
"downstream_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"
}
}
}Legacy Search flows
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
Responseall of
post
POST /app/v1/flows/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 189
{
"page": 0,
"page_size": 20,
"sort_by": "name",
"sort_direction": "desc",
"filter": {
"$or": [
{
"type": "fuel",
"product_type": "natural_gas",
"product_category": "natural_gas"
},
{
"name": {
"$like": "test"
}
}
]
}
}200
successful operation
{
"page_number": 0,
"page_size": 10,
"total_entries": 58,
"total_pages": 6,
"data": [
{
"name": "text",
"type": "text",
"status": "active",
"product_category": "text",
"product_type": "text",
"custom_attributes": {
"attribute1": 12345,
"attribute2": "value1"
},
"upstream_flow_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"downstream_flow_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"upstream_flows_count": 1,
"downstream_flows_count": 1,
"upstream_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"downstream_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"upstream_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"downstream_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"associated_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"associated_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-08-19T00:19:43.005Z",
"updated_at": "2025-08-19T00:19:43.005Z",
"created_by": "123e4567-e89b-12d3-a456-426614174000",
"updated_by": "123e4567-e89b-12d3-a456-426614174000"
},
{
"upstream_flows": [
{
"name": "text",
"type": "text",
"status": "active",
"product_category": "text",
"product_type": "text",
"custom_attributes": {
"attribute1": 12345,
"attribute2": "value1"
},
"upstream_flow_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"downstream_flow_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"upstream_flows_count": 1,
"downstream_flows_count": 1,
"upstream_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"downstream_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"upstream_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"downstream_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"associated_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"associated_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-08-19T00:19:43.005Z",
"updated_at": "2025-08-19T00:19:43.005Z",
"created_by": "123e4567-e89b-12d3-a456-426614174000",
"updated_by": "123e4567-e89b-12d3-a456-426614174000"
}
],
"downstream_flows": [
{
"name": "text",
"type": "text",
"status": "active",
"product_category": "text",
"product_type": "text",
"custom_attributes": {
"attribute1": 12345,
"attribute2": "value1"
},
"upstream_flow_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"downstream_flow_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"upstream_flows_count": 1,
"downstream_flows_count": 1,
"upstream_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"downstream_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"upstream_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"downstream_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"id": "123e4567-e89b-12d3-a456-426614174000",
"associated_facility_id": "123e4567-e89b-12d3-a456-426614174000",
"associated_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
"created_at": "2025-08-19T00:19:43.005Z",
"updated_at": "2025-08-19T00:19:43.005Z",
"created_by": "123e4567-e89b-12d3-a456-426614174000",
"updated_by": "123e4567-e89b-12d3-a456-426614174000"
}
]
},
{
"upstream_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"
}
},
"downstream_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"
}
}
},
{
"upstream_facility": {
"created_at": "2025-08-19T00:19:43.005Z",
"updated_at": "2025-08-19T00:19:43.005Z",
"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"
},
"downstream_facility": {
"created_at": "2025-08-19T00:19:43.005Z",
"updated_at": "2025-08-19T00:19:43.005Z",
"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"
}
},
{
"associated_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"
}
}
},
{
"associated_facility": {
"created_at": "2025-08-19T00:19:43.005Z",
"updated_at": "2025-08-19T00:19:43.005Z",
"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"
}
}
]
}Last updated