Sign in
Runs

Query the steps of a run

Changed on

list all run steps

get/projects/{owner}/{name}/runs/{run_id}/all-steps

Request

  • The document declares no server URL.
  • Auth: one of:
    • HTTP bearer
    • API key in header x-pollination-token

Path parameters

ownerstring required
namestring required
run_idstring required

Response

Retrieved

started_atstring date-time required

The time at which the task was started

idstring required

The step unique ID

namestring required

A human readable name for the step. Usually defined by the DAG task name but can be extended if the step is part of a loop for example. This name is unique within the boundary of the DAG/Job that generated it.

status_type'Function' | 'DAG' | 'Loop' | 'Container' | 'Unknown' required

Type enum for status type.

template_refstring required

The name of the template that spawned this step

children_idsstring[] required

A list of child step IDs

outbound_stepsstring[] required

A list of the last step to ran in the context of this step. In the case of a DAG or a job this will be the last step that has been executed. It will remain empty for functions.

typestring
annotationsobject

An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries.

messagestring

Any message produced by the task. Usually error/debugging hints.

finished_atstring date-time

The time at which the task was completed

sourcestring

Source url for the status object. It can be a recipe or a function.

status'Scheduled' | 'Running' | 'Failed' | 'Succeeded' | 'Skipped' | 'Unknown'

Enumaration of allowable status strings

commandstring

The command used to run this step. Only applies to Function steps.

boundary_idstring

This indicates the step ID of the associated template root step in which this step belongs to. A DAG step will have the id of the parent DAG for example.

Example response

[
  {
    "inputs": [
      {
        "alias": [
          {
            "handler": [
              {
                "module": "honeybee_rhino.handlers"
              }
            ]
          }
        ]
      }
    ]
  }
]

Changes