Grid Edge Observation Pull

name: Grid Edge Observation Pull
description: |
  Workflow capability that pulls a time-bounded window of observations from a set
  of Itron Starfish devices (typically grid-edge sensors), paginating through the
  cursor-based response and assembling a normalized dataset for analytics.
url: https://github.com/api-evangelist/itron/capabilities/grid-edge-observation-pull.yaml
created: '2026-05-23'
modified: '2026-05-23'

uses:
- ./shared/starfish-data-platform.yaml

inputs:
- name: deviceType
  required: true
- name: from
  required: true
  description: ISO-8601 start timestamp (inclusive).
- name: to
  required: true
  description: ISO-8601 end timestamp (exclusive).
- name: tags
  required: false
- name: pageLimit
  default: 100

steps:

- id: discoverDevices
  description: Find every device of the requested type.
  capability: starfish-data-platform.Devices.queryDevices
  body:
    deviceType: ${inputs.deviceType}
  output: devices

- id: pullObservations
  description: For each device, page through observations in the requested window.
  for_each: ${devices.devices}
  as: device
  capability: starfish-data-platform.Observations.queryDeviceObservations
  path:
    deviceId: ${device.id}
  body:
    from: ${inputs.from}
    to: ${inputs.to}
    tags: ${inputs.tags}
  paginate:
    cursor: next_page
    cursor_param: after
    max_pages: ${inputs.pageLimit}
  output: observations

- id: emitDataset
  description: Emit the merged observation set for downstream analytics.
  output:
    deviceCount: ${devices.devices | length}
    observations: ${observations}