latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

estimation_methods

Run calculators based on filtered configurations

post/app/v1/estimation_methods/run

Query parameters

previewstring

Run calculation without saving the results (true)

promote_to_recordstring

Run calculation and create records from the results

Request body

Example request

{
  "filters": {
    "estimation_method.analytics_calculator_id": "AcidGasRemovalMethod1",
    "estimation_method.analytics_library_id": "SubpartW",
    "estimation_method.entity_id": "a48fdf7a-c4c1-45ae-a794-139b134b622b",
    "flow.custom_attributes": {
      "attribute1": 12345,
      "attribute2": "value1"
    }
  }
}

Response

Successfully ran estimation method calculations

Example response

{
  "data": [
    {
      "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"
          }
        ]
      }
    }
  ]
}