Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

flows

Export Flows

post/app/v1/flows/export

Query parameters

periodstring

year month (YYYYMM), defaulting to the current time, indicates which time period to return the attributes and custom attributes from

Request body

sort_by'name' | 'status' | 'product_category' | 'product_type' | 'created_at' | 'updated_at'
sort_direction'asc' | 'desc'

Sort direction

Example request

{
  "sort_by": "name",
  "sort_direction": "desc",
  "filter": {
    "$or": [
      {
        "type": "fuel",
        "product_type": "natural_gas",
        "product_category": "natural_gas"
      },
      {
        "name": {
          "$like": "test"
        }
      }
    ]
  }
}

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"
  }
}