DAdagucloud
dag-runs

List the items of a foreach step in a sub DAG-run

Changed on

Lists the items a foreach step expanded to, with the status each item's body run reached. Items are sorted failed first, then running, then the rest in index order. Nested foreach items are listed by passing the parent path a body step reports as foreachParent.

get/dag-runs/{name}/{dagRunId}/sub-dag-runs/{subDAGRunId}/steps/{stepName}/foreach

Request

  • Base URL
    http://localhost/api/v1
  • Auth
    • HTTP bearer
    • or HTTP basic
    • or none

Path parameters

namestring regex required

Name of the DAG

name of the DAG

dagRunIdstring required

Unique identifier for the DAG-run. The special value 'latest' can be used to reference the most recent DAG-run.

Example:latest

ID of the DAG-run or 'latest' to get the most recent DAG-run

subDAGRunIdstring required

ID of the sub DAG-run

stepNamestring required

name of the step

Query parameters

remoteNodestring

name of the remote node

parentstring

Lists the items of a nested foreach instead of the step's own items. The value is the foreachParent a body step reports, such as 2.inner.

status'not_started' | 'running' | 'succeeded' | 'failed' | 'aborted'

Status of a foreach item's body run

only list items whose body run reached this status

pageinteger

page number of items to fetch (default is 1)

perPageinteger

number of items per page (default is 30, max is 100)

Response

A successful response

totalinteger required

Number of items the step expanded to, before any status filter

Changes