Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

estimation_methods

Search and list Estimation Methods with calculator configs and runs

post/app/v1/estimation_methods/search/configurations

Request body

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

sort_by'name' | 'year_month' | 'entity_id' | 'entity_type' | 'analytics_library_id' | 'analytics_calculator_id' | 'created_at' | 'updated_at'
sort_direction'asc' | 'desc'

Sort direction

Example request

{
  "page_size": 20,
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "year_month": {
      "$in": [
        202301,
        202302,
        202303
      ]
    }
  }
}

Response

Successfully something

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "analytics_library_id": "2024-SubpartW",
      "analytics_calculator_id": "2024-SubpartW-AcidGasRemovalMethod1",
      "name": "SubpartW AGR Method",
      "default_values": {
        "fuel_type": {
          "value": "Eastern",
          "unit": "",
          "measurement_type": "measurement_type",
          "measurement_quantity": "dimensionless_coefficient"
        },
        "volume": {
          "value": 5,
          "unit": "e3m3",
          "measurement_type": "measurement_type",
          "measurement_quantity": "volume"
        }
      },
      "default_asset_values": {
        "a04b4387-5145-4935-9edc-d53ecdb7a6c0": {
          "fuel_type": {
            "value": "Eastern",
            "unit": "",
            "measurement_type": "measurement_type",
            "measurement_quantity": "dimensionless_coefficient"
          },
          "volume": {
            "value": 5,
            "unit": "e3m3",
            "measurement_type": "measurement_type",
            "measurement_quantity": "volume"
          }
        },
        "99a45dd3-6ce1-4290-9d16-79415111cc43": {
          "fuel_type": {
            "value": "Eastern",
            "unit": "",
            "measurement_type": "measurement_type",
            "measurement_quantity": "dimensionless_coefficient"
          },
          "volume": {
            "value": 5,
            "unit": "e3m3",
            "measurement_type": "measurement_type",
            "measurement_quantity": "volume"
          }
        }
      },
      "year_month": "202101",
      "calculator_configuration": {
        "inputs": {
          "fuel_type": {
            "value": "Eastern",
            "unit": "",
            "measurement_type": "measurement_type",
            "measurement_quantity": "dimensionless_coefficient"
          },
          "volume": {
            "value": 5,
            "unit": "e3m3",
            "measurement_type": "measurement_type",
            "measurement_quantity": "volume"
          },
          "rvp": null
        },
        "calculator_version": "V1"
      },
      "calculator_run": {
        "input": {
          "id": "bfbd6b12-4229-4c43-b08f-94f2a72fa0f8_202305",
          "calculation": {
            "calculation_id": "CO2InjectedMassFlowMeterV1"
          }
        },
        "output": {
          "intermediates": [
            {
              "measurement_quantity": "Mass CO2",
              "measurement_type": "Mass",
              "measurement_unit": "grams",
              "measurement_value": 25400,
              "description": "Mass of CO2 injected",
              "type": "number"
            }
          ],
          "outputs": [
            {
              "measurement_quantity": "Mass CO2",
              "measurement_type": "Mass",
              "measurement_unit": "grams",
              "measurement_value": 25400,
              "description": "Mass of CO2 injected",
              "type": "number"
            }
          ]
        }
      },
      "reporting_groups": [
        {
          "name": "SubpartW",
          "description": "my reporting group",
          "priority": 2,
          "id": "subpartw"
        }
      ]
    }
  ]
}