DAdagucloud
dag-runs

Retrieve one item of a foreach step in a DAG-run

Changed on

Fetches an item's body run: its status and the status of each body step

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

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

stepNamestring required

name of the step

itemstring required

Path of a foreach item: the item index, or for an item of a nested foreach the parent path reported as foreachParent followed by a dot and the item index, such as 2.inner.0.

Query parameters

remoteNodestring

name of the remote node

Response

A successful response

itemstring required

Path that addresses the item in the foreach item routes

indexinteger required
keystring required
status0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 required

Numeric status code indicating current node state: 0: "Not started" 1: "Running" 2: "Failed" 3: "Aborted" 4: "Success" 5: "Skipped" 6: "Partial Success" 7: "Waiting for manual action" 8: "Rejected" 9: "Retrying"

statusLabel'not_started' | 'running' | 'failed' | 'aborted' | 'succeeded' | 'skipped' | 'partially_succeeded' | 'waiting' | 'rejected' | 'retrying' required

Human-readable status description for the node

errorstring
startedAtstring

RFC 3339 timestamp with millisecond precision when the body run started

finishedAtstring

RFC 3339 timestamp with millisecond precision when the body run finished

Changes

  • v12423ce6c5598Revision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • v19291d665c8f2Revision changes
    • info

      endpoint added