Sign in
flows

Get a flow

get/app/v1/flows/{id}

Path parameters

idstring uuid required

Flow ID

Query parameters

periodstring

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

Response

A successful operation

OR
OR
OR

Example response

{
  "custom_attributes": {
    "attribute1": 12345,
    "attribute2": "value1"
  },
  "upstream_flows": [
    {
      "custom_attributes": {
        "attribute1": 12345,
        "attribute2": "value1"
      }
    }
  ],
  "downstream_flows": [
    {
      "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
  }
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.