Sign in
latestOpenAPI 3.0.12026-08-103995881.2 MB

053edab62415

flows

Search and list Flows

post/app/v2/flows/search

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

pagenumber

Which page to return

page_sizenumber

How many items to list in a page

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

Sort direction

Example request

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

Response

successful operation

page_numbernumber
page_sizenumber
total_entriesnumber
total_pagesnumber

Example response

{
  "page_size": 10,
  "total_entries": 58,
  "total_pages": 6,
  "data": [
    {
      "custom_attributes": {
        "attribute1": 12345,
        "attribute2": "value1"
      },
      "upstream_equipment": {
        "custom_attributes": {
          "attribute1": 12345,
          "attribute2": "value1"
        },
        "effective_date": "2022-01-01",
        "latitude": 51,
        "longitude": -114
      },
      "downstream_equipment": {
        "custom_attributes": {
          "attribute1": 12345,
          "attribute2": "value1"
        },
        "effective_date": "2022-01-01",
        "latitude": 51,
        "longitude": -114
      },
      "upstream_facility": {
        "custom_attributes": {
          "attribute1": 12345,
          "attribute2": "value1"
        },
        "latitude": 51,
        "longitude": -114
      },
      "downstream_facility": {
        "custom_attributes": {
          "attribute1": 12345,
          "attribute2": "value1"
        },
        "latitude": 51,
        "longitude": -114
      },
      "associated_equipment": {
        "custom_attributes": {
          "attribute1": 12345,
          "attribute2": "value1"
        },
        "effective_date": "2022-01-01",
        "latitude": 51,
        "longitude": -114
      },
      "associated_facility": {
        "custom_attributes": {
          "attribute1": 12345,
          "attribute2": "value1"
        },
        "latitude": 51,
        "longitude": -114
      }
    }
  ]
}