Sign in
calculator_results

Export Calculator Results

post/app/v1/calculator_results/export

Request body

sort_bystring

any field from group_by param

sort_direction'asc' | 'desc'

Sort direction

group_bystring[]

Example request

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

Response

successful operation

idstring uuid required
namestring required
company_idstring uuid required
status'exporting' | 'failed' | 'success' required
templated_report_namestring
inputobject

User input for a templated report based on the input schema for the desired templated report.

s3_object_idstring
report_versionstring
created_bystring uuid required
updated_bystring uuid required
s3_download_linkstring

Example response

{
  "input": {
    "year_month": 202201,
    "reporting_group_id": "bc37cb31-08ce-4b22-8f4c-7d44692a4ef2",
    "asset_id": "89c100dc-0401-447f-a9f5-72ae124f3244"
  }
}