Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

calculator_results

Search and aggregate Calculator Result

post/app/v1/calculator_results

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_bystring

any field from group_by param

sort_direction'asc' | 'desc'

Sort direction

group_bystring[]

Example request

{
  "page_size": 20,
  "sort_direction": "desc",
  "filter": {
    "flow.custom_attributes": {
      "attribute1": 12345,
      "attribute2": "value1"
    },
    "entity_type": "equipment",
    "reporting_group": "subpartw"
  }
}

Response

successful operation

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "result_category": "outputs",
      "measurement_unit": "g",
      "equipment": {
        "custom_attributes": {
          "attribute1": 12345,
          "attribute2": "value1"
        },
        "effective_date": "2022-01-01",
        "latitude": 51,
        "longitude": -114
      }
    }
  ]
}