Records

A fundamental data model of Validere that represents a quantifiable measurement associated with an asset that is defined per context and time period.

https://api.validere.io/app

Search records

Search and list records

post

Query parameters

asset_detailstringOptional

set to true to include asset detail when group by <asset_type>.id

Example: true

Body

all ofOptional

and

and

Responses

200

A successful operation

application/json

Responseall of

post

HTTPcURLJavaScriptPython

POST /app/v1/records/search HTTP/1.1
Host: api.validere.io
Content-Type: application/json
Accept: */*
Content-Length: 1425

{
  "page": 0,
  "page_size": 20,
  "sort_by": "text",
  "sort_direction": "desc",
  "filter": {
    "facility.custom_attributes": {},
    "facility.id": "text",
    "facility.name": "text",
    "facility.status": "text",
    "equipment.custom_attributes": {},
    "equipment.id": "text",
    "equipment.name": "text",
    "equipment.status": "active",
    "equipment.type.id": "text",
    "equipment.type.name": "text",
    "equipment.facility.custom_attributes": {},
    "equipment.facility.id": "text",
    "equipment.facility.name": "text",
    "equipment.facility.status": "text",
    "device.attributes": {},
    "device.custom_attributes": {},
    "device.id": "text",
    "device.measurement_types": "text",
    "device.name": "text",
    "device.status": "text",
    "device.type_id": "text",
    "flow.id": "text",
    "flow.name": "text",
    "flow.status": "active",
    "flow.type": "text",
    "flow.product_type": "text",
    "flow.product_category": "text",
    "flow.custom_attributes": {
      "attribute1": 12345,
      "attribute2": "value1"
    },
    "flow.associated_facility_id": "123e4567-e89b-12d3-a456-426614174000",
    "flow.associated_equipment_id": "123e4567-e89b-12d3-a456-426614174000",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "asset_type": "equipment",
    "asset_id": {
      "$in": [
        "c3e9446d-4cc0-4e7b-bb43-43fff9361957",
        "c3e9446d-4cc0-4e7b-bb43-43fff9361957"
      ]
    },
    "reporting_group_id": "subpartw",
    "year_month": 202201,
    "measurement_type": "text",
    "record_value.id": "123e4567-e89b-12d3-a456-426614174000",
    "flow.associated_facility.custom_attributes": {},
    "flow.associated_equipment.custom_attributes": {}
  },
  "group_by": [
    "year_month"
  ]
}

200

A successful operation

{
  "page_number": 0,
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "reporting_group_id": "text",
      "year_month": 202212,
      "values": [
        {
          "measurement_type": "text",
          "measurement_unit": "text",
          "value": 0.22,
          "configuration": {
            "configuration_type": "manual",
            "value": 1,
            "sources": [
              {}
            ]
          }
        }
      ]
    }
  ]
}