--- title: "Query the steps of a run" method: GET path: "/projects/{owner}/{name}/runs/{run_id}/all-steps" tags: ["Runs"] --- # Query the steps of a run `GET /projects/{owner}/{name}/runs/{run_id}/all-steps` list all run steps ## Path parameters - `owner` string, required - `name` string, required - `run_id` string, required ## Response `200` Retrieved - StepStatus[] - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `inputs` union[], required — The inputs used by this step. - union - StepStringInput — A String input. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Input name. - `description` string — Optional description for input. - `default` string — Default value to use for an input if a value was not supplied. - `alias` union[] — A list of aliases for this input in different platforms. - union - DAGGenericInputAlias — Base class for DAG Alias inputs. This class adds a handler to input to handle the process of loading the input from different graphical interfaces. - … - DAGStringInputAlias — An Alias String input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGIntegerInputAlias — An alias integer input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGNumberInputAlias — An alias number input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGBooleanInputAlias — The boolean type matches only two special values: True and False. Note that values that evaluate to true or false, such as 1 and 0, are not accepted. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/boolean.html for more information. - … - DAGFolderInputAlias — An alias folder input. Folder is a special string input. Unlike other string inputs, a folder will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, } - … - DAGFileInputAlias — An alias file input. File is a special string input. Unlike other string inputs, a file will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGPathInputAlias — A file or a folder input. Use this input only in cases that the input can be either a file or folder. For file or folder-only inputs see File and Folder. Path is a special string input. Unlike other string inputs, a path will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGArrayInputAlias — A JSON array input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/array.html for more information. - … - DAGJSONObjectInputAlias — An alias JSON object input. JSON objects are similar to Python dictionaries. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/object.html for more information. - … - DAGLinkedInputAlias — An Alias for Linked Inputs. A linked input alias will be hidden in the UI and will be linked to an object in the UI using the input handler. - … - `required` boolean — A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided. - `spec` object — An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec. - `value` string, required - StepIntegerInput — An integer input. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Input name. - `description` string — Optional description for input. - `default` integer — Default value to use for an input if a value was not supplied. - `alias` union[] — A list of aliases for this input in different platforms. - union - DAGGenericInputAlias — Base class for DAG Alias inputs. This class adds a handler to input to handle the process of loading the input from different graphical interfaces. - … - DAGStringInputAlias — An Alias String input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGIntegerInputAlias — An alias integer input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGNumberInputAlias — An alias number input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGBooleanInputAlias — The boolean type matches only two special values: True and False. Note that values that evaluate to true or false, such as 1 and 0, are not accepted. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/boolean.html for more information. - … - DAGFolderInputAlias — An alias folder input. Folder is a special string input. Unlike other string inputs, a folder will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, } - … - DAGFileInputAlias — An alias file input. File is a special string input. Unlike other string inputs, a file will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGPathInputAlias — A file or a folder input. Use this input only in cases that the input can be either a file or folder. For file or folder-only inputs see File and Folder. Path is a special string input. Unlike other string inputs, a path will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGArrayInputAlias — A JSON array input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/array.html for more information. - … - DAGJSONObjectInputAlias — An alias JSON object input. JSON objects are similar to Python dictionaries. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/object.html for more information. - … - DAGLinkedInputAlias — An Alias for Linked Inputs. A linked input alias will be hidden in the UI and will be linked to an object in the UI using the input handler. - … - `required` boolean — A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided. - `spec` object — An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec. - `value` integer, required - StepNumberInput — A number input. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Input name. - `description` string — Optional description for input. - `default` number — Default value to use for an input if a value was not supplied. - `alias` union[] — A list of aliases for this input in different platforms. - union - DAGGenericInputAlias — Base class for DAG Alias inputs. This class adds a handler to input to handle the process of loading the input from different graphical interfaces. - … - DAGStringInputAlias — An Alias String input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGIntegerInputAlias — An alias integer input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGNumberInputAlias — An alias number input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGBooleanInputAlias — The boolean type matches only two special values: True and False. Note that values that evaluate to true or false, such as 1 and 0, are not accepted. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/boolean.html for more information. - … - DAGFolderInputAlias — An alias folder input. Folder is a special string input. Unlike other string inputs, a folder will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, } - … - DAGFileInputAlias — An alias file input. File is a special string input. Unlike other string inputs, a file will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGPathInputAlias — A file or a folder input. Use this input only in cases that the input can be either a file or folder. For file or folder-only inputs see File and Folder. Path is a special string input. Unlike other string inputs, a path will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGArrayInputAlias — A JSON array input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/array.html for more information. - … - DAGJSONObjectInputAlias — An alias JSON object input. JSON objects are similar to Python dictionaries. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/object.html for more information. - … - DAGLinkedInputAlias — An Alias for Linked Inputs. A linked input alias will be hidden in the UI and will be linked to an object in the UI using the input handler. - … - `required` boolean — A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided. - `spec` object — An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec. - `value` number, required - StepBooleanInput — The boolean type matches only two special values: True and False. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Input name. - `description` string — Optional description for input. - `default` boolean — Default value to use for an input if a value was not supplied. - `alias` union[] — A list of aliases for this input in different platforms. - union - DAGGenericInputAlias — Base class for DAG Alias inputs. This class adds a handler to input to handle the process of loading the input from different graphical interfaces. - … - DAGStringInputAlias — An Alias String input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGIntegerInputAlias — An alias integer input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGNumberInputAlias — An alias number input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGBooleanInputAlias — The boolean type matches only two special values: True and False. Note that values that evaluate to true or false, such as 1 and 0, are not accepted. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/boolean.html for more information. - … - DAGFolderInputAlias — An alias folder input. Folder is a special string input. Unlike other string inputs, a folder will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, } - … - DAGFileInputAlias — An alias file input. File is a special string input. Unlike other string inputs, a file will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGPathInputAlias — A file or a folder input. Use this input only in cases that the input can be either a file or folder. For file or folder-only inputs see File and Folder. Path is a special string input. Unlike other string inputs, a path will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGArrayInputAlias — A JSON array input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/array.html for more information. - … - DAGJSONObjectInputAlias — An alias JSON object input. JSON objects are similar to Python dictionaries. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/object.html for more information. - … - DAGLinkedInputAlias — An Alias for Linked Inputs. A linked input alias will be hidden in the UI and will be linked to an object in the UI using the input handler. - … - `required` boolean — A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided. - `spec` object — An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec. - `value` boolean, required - StepFolderInput — A folder input. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Input name. - `description` string — Optional description for input. - `default` union — The default source for file if the value is not provided. - HTTP — HTTP Source A web HTTP to an FTP server or an API for example. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `url` string, required — For a HTTP endpoint this can be http://climate.onebuilding.org. - S3 — S3 Source An S3 bucket artifact Source. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `key` string, required — The path inside the bucket to source artifacts from. - `endpoint` string, required — The HTTP endpoint to reach the S3 bucket. - `bucket` string, required — The name of the S3 bucket on the host server. - `credentials_path` string — Path to the file holding the AccessKey and SecretAccessKey to authenticate to the bucket. Assumes public bucket access if none are specified. - ProjectFolder — Project Folder Source This is the path to a folder where files and folders can be sourced. In the context of a desktop run Workflow this folder will correspond to a local folder. In the context of a workflow run on Pollination this folder will correspond to a Project scoped folder. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `path` string — The path to a folder where files and folders can be sourced. For a local filesystem this can be "C:\Users\me\jobs\test". - `alias` union[] — A list of aliases for this input in different platforms. - union - DAGGenericInputAlias — Base class for DAG Alias inputs. This class adds a handler to input to handle the process of loading the input from different graphical interfaces. - … - DAGStringInputAlias — An Alias String input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGIntegerInputAlias — An alias integer input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGNumberInputAlias — An alias number input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGBooleanInputAlias — The boolean type matches only two special values: True and False. Note that values that evaluate to true or false, such as 1 and 0, are not accepted. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/boolean.html for more information. - … - DAGFolderInputAlias — An alias folder input. Folder is a special string input. Unlike other string inputs, a folder will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, } - … - DAGFileInputAlias — An alias file input. File is a special string input. Unlike other string inputs, a file will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGPathInputAlias — A file or a folder input. Use this input only in cases that the input can be either a file or folder. For file or folder-only inputs see File and Folder. Path is a special string input. Unlike other string inputs, a path will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGArrayInputAlias — A JSON array input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/array.html for more information. - … - DAGJSONObjectInputAlias — An alias JSON object input. JSON objects are similar to Python dictionaries. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/object.html for more information. - … - DAGLinkedInputAlias — An Alias for Linked Inputs. A linked input alias will be hidden in the UI and will be linked to an object in the UI using the input handler. - … - `required` boolean — A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided. - `spec` object — An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec. - `path` string — Path to the target location that the input will be copied to. This path is relative to the working directory where the command is executed. - `source` union, required — The path to source the file from. - HTTP — HTTP Source A web HTTP to an FTP server or an API for example. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `url` string, required — For a HTTP endpoint this can be http://climate.onebuilding.org. - S3 — S3 Source An S3 bucket artifact Source. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `key` string, required — The path inside the bucket to source artifacts from. - `endpoint` string, required — The HTTP endpoint to reach the S3 bucket. - `bucket` string, required — The name of the S3 bucket on the host server. - `credentials_path` string — Path to the file holding the AccessKey and SecretAccessKey to authenticate to the bucket. Assumes public bucket access if none are specified. - ProjectFolder — Project Folder Source This is the path to a folder where files and folders can be sourced. In the context of a desktop run Workflow this folder will correspond to a local folder. In the context of a workflow run on Pollination this folder will correspond to a Project scoped folder. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `path` string — The path to a folder where files and folders can be sourced. For a local filesystem this can be "C:\Users\me\jobs\test". - StepFileInput — A file input. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Input name. - `description` string — Optional description for input. - `default` union — The default source for file if the value is not provided. - HTTP — HTTP Source A web HTTP to an FTP server or an API for example. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `url` string, required — For a HTTP endpoint this can be http://climate.onebuilding.org. - S3 — S3 Source An S3 bucket artifact Source. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `key` string, required — The path inside the bucket to source artifacts from. - `endpoint` string, required — The HTTP endpoint to reach the S3 bucket. - `bucket` string, required — The name of the S3 bucket on the host server. - `credentials_path` string — Path to the file holding the AccessKey and SecretAccessKey to authenticate to the bucket. Assumes public bucket access if none are specified. - ProjectFolder — Project Folder Source This is the path to a folder where files and folders can be sourced. In the context of a desktop run Workflow this folder will correspond to a local folder. In the context of a workflow run on Pollination this folder will correspond to a Project scoped folder. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `path` string — The path to a folder where files and folders can be sourced. For a local filesystem this can be "C:\Users\me\jobs\test". - `alias` union[] — A list of aliases for this input in different platforms. - union - DAGGenericInputAlias — Base class for DAG Alias inputs. This class adds a handler to input to handle the process of loading the input from different graphical interfaces. - … - DAGStringInputAlias — An Alias String input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGIntegerInputAlias — An alias integer input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGNumberInputAlias — An alias number input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGBooleanInputAlias — The boolean type matches only two special values: True and False. Note that values that evaluate to true or false, such as 1 and 0, are not accepted. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/boolean.html for more information. - … - DAGFolderInputAlias — An alias folder input. Folder is a special string input. Unlike other string inputs, a folder will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, } - … - DAGFileInputAlias — An alias file input. File is a special string input. Unlike other string inputs, a file will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGPathInputAlias — A file or a folder input. Use this input only in cases that the input can be either a file or folder. For file or folder-only inputs see File and Folder. Path is a special string input. Unlike other string inputs, a path will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGArrayInputAlias — A JSON array input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/array.html for more information. - … - DAGJSONObjectInputAlias — An alias JSON object input. JSON objects are similar to Python dictionaries. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/object.html for more information. - … - DAGLinkedInputAlias — An Alias for Linked Inputs. A linked input alias will be hidden in the UI and will be linked to an object in the UI using the input handler. - … - `required` boolean — A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided. - `spec` object — An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec. - `path` string — Path to the target location that the input will be copied to. This path is relative to the working directory where the command is executed. - `extensions` string[] — Optional list of extensions for file. The check for extension is case-insensitive. - `source` union, required — The path to source the file from. - HTTP — HTTP Source A web HTTP to an FTP server or an API for example. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `url` string, required — For a HTTP endpoint this can be http://climate.onebuilding.org. - S3 — S3 Source An S3 bucket artifact Source. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `key` string, required — The path inside the bucket to source artifacts from. - `endpoint` string, required — The HTTP endpoint to reach the S3 bucket. - `bucket` string, required — The name of the S3 bucket on the host server. - `credentials_path` string — Path to the file holding the AccessKey and SecretAccessKey to authenticate to the bucket. Assumes public bucket access if none are specified. - ProjectFolder — Project Folder Source This is the path to a folder where files and folders can be sourced. In the context of a desktop run Workflow this folder will correspond to a local folder. In the context of a workflow run on Pollination this folder will correspond to a Project scoped folder. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `path` string — The path to a folder where files and folders can be sourced. For a local filesystem this can be "C:\Users\me\jobs\test". - StepPathInput — A file or a folder input. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Input name. - `description` string — Optional description for input. - `default` union — The default source for file if the value is not provided. - HTTP — HTTP Source A web HTTP to an FTP server or an API for example. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `url` string, required — For a HTTP endpoint this can be http://climate.onebuilding.org. - S3 — S3 Source An S3 bucket artifact Source. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `key` string, required — The path inside the bucket to source artifacts from. - `endpoint` string, required — The HTTP endpoint to reach the S3 bucket. - `bucket` string, required — The name of the S3 bucket on the host server. - `credentials_path` string — Path to the file holding the AccessKey and SecretAccessKey to authenticate to the bucket. Assumes public bucket access if none are specified. - ProjectFolder — Project Folder Source This is the path to a folder where files and folders can be sourced. In the context of a desktop run Workflow this folder will correspond to a local folder. In the context of a workflow run on Pollination this folder will correspond to a Project scoped folder. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `path` string — The path to a folder where files and folders can be sourced. For a local filesystem this can be "C:\Users\me\jobs\test". - `alias` union[] — A list of aliases for this input in different platforms. - union - DAGGenericInputAlias — Base class for DAG Alias inputs. This class adds a handler to input to handle the process of loading the input from different graphical interfaces. - … - DAGStringInputAlias — An Alias String input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGIntegerInputAlias — An alias integer input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGNumberInputAlias — An alias number input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGBooleanInputAlias — The boolean type matches only two special values: True and False. Note that values that evaluate to true or false, such as 1 and 0, are not accepted. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/boolean.html for more information. - … - DAGFolderInputAlias — An alias folder input. Folder is a special string input. Unlike other string inputs, a folder will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, } - … - DAGFileInputAlias — An alias file input. File is a special string input. Unlike other string inputs, a file will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGPathInputAlias — A file or a folder input. Use this input only in cases that the input can be either a file or folder. For file or folder-only inputs see File and Folder. Path is a special string input. Unlike other string inputs, a path will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGArrayInputAlias — A JSON array input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/array.html for more information. - … - DAGJSONObjectInputAlias — An alias JSON object input. JSON objects are similar to Python dictionaries. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/object.html for more information. - … - DAGLinkedInputAlias — An Alias for Linked Inputs. A linked input alias will be hidden in the UI and will be linked to an object in the UI using the input handler. - … - `required` boolean — A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided. - `spec` object — An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec. - `path` string — Path to the target location that the input will be copied to. This path is relative to the working directory where the command is executed. - `extensions` string[] — Optional list of extensions for file. The check for extension is case-insensitive. - `source` union, required — The path to source the file from. - HTTP — HTTP Source A web HTTP to an FTP server or an API for example. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `url` string, required — For a HTTP endpoint this can be http://climate.onebuilding.org. - S3 — S3 Source An S3 bucket artifact Source. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `key` string, required — The path inside the bucket to source artifacts from. - `endpoint` string, required — The HTTP endpoint to reach the S3 bucket. - `bucket` string, required — The name of the S3 bucket on the host server. - `credentials_path` string — Path to the file holding the AccessKey and SecretAccessKey to authenticate to the bucket. Assumes public bucket access if none are specified. - ProjectFolder — Project Folder Source This is the path to a folder where files and folders can be sourced. In the context of a desktop run Workflow this folder will correspond to a local folder. In the context of a workflow run on Pollination this folder will correspond to a Project scoped folder. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `path` string — The path to a folder where files and folders can be sourced. For a local filesystem this can be "C:\Users\me\jobs\test". - StepArrayInput — A JSON array input. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Input name. - `description` string — Optional description for input. - `default` unknown[] — Default value to use for an input if a value was not supplied. - unknown - `alias` union[] — A list of aliases for this input in different platforms. - union - DAGGenericInputAlias — Base class for DAG Alias inputs. This class adds a handler to input to handle the process of loading the input from different graphical interfaces. - … - DAGStringInputAlias — An Alias String input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGIntegerInputAlias — An alias integer input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGNumberInputAlias — An alias number input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGBooleanInputAlias — The boolean type matches only two special values: True and False. Note that values that evaluate to true or false, such as 1 and 0, are not accepted. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/boolean.html for more information. - … - DAGFolderInputAlias — An alias folder input. Folder is a special string input. Unlike other string inputs, a folder will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, } - … - DAGFileInputAlias — An alias file input. File is a special string input. Unlike other string inputs, a file will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGPathInputAlias — A file or a folder input. Use this input only in cases that the input can be either a file or folder. For file or folder-only inputs see File and Folder. Path is a special string input. Unlike other string inputs, a path will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGArrayInputAlias — A JSON array input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/array.html for more information. - … - DAGJSONObjectInputAlias — An alias JSON object input. JSON objects are similar to Python dictionaries. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/object.html for more information. - … - DAGLinkedInputAlias — An Alias for Linked Inputs. A linked input alias will be hidden in the UI and will be linked to an object in the UI using the input handler. - … - `required` boolean — A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided. - `spec` object — An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec. - `items_type` 'Generic' | 'String' | 'Integer' | 'Number' | 'Boolean' | 'Array' | 'JSONObject' — Type enum for items in a list. Items can not be files or folder. For a list of files you should copy them to a folder and use FolderInput input instead of using ArrayInput. - `value` unknown[], required - unknown - StepJSONObjectInput — A JSON object input. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Input name. - `description` string — Optional description for input. - `default` object — Default value to use for an input if a value was not supplied. - `alias` union[] — A list of aliases for this input in different platforms. - union - DAGGenericInputAlias — Base class for DAG Alias inputs. This class adds a handler to input to handle the process of loading the input from different graphical interfaces. - … - DAGStringInputAlias — An Alias String input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGIntegerInputAlias — An alias integer input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGNumberInputAlias — An alias number input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/numeric.html#numeric for more information. - … - DAGBooleanInputAlias — The boolean type matches only two special values: True and False. Note that values that evaluate to true or false, such as 1 and 0, are not accepted. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/boolean.html for more information. - … - DAGFolderInputAlias — An alias folder input. Folder is a special string input. Unlike other string inputs, a folder will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python "schema": { "type": "string", "maxLength": 50, } - … - DAGFileInputAlias — An alias file input. File is a special string input. Unlike other string inputs, a file will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGPathInputAlias — A file or a folder input. Use this input only in cases that the input can be either a file or folder. For file or folder-only inputs see File and Folder. Path is a special string input. Unlike other string inputs, a path will be copied from its location to execution folder when a workflow is executed. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/string.html#string for more information. .. code-block:: python # a file with maximum 50 characters with an ``epw`` extension. "schema": { "type": "string", "maxLength": 50, "pattern": "(?i)(^.*\.epw$)" } - … - DAGArrayInputAlias — A JSON array input. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/array.html for more information. - … - DAGJSONObjectInputAlias — An alias JSON object input. JSON objects are similar to Python dictionaries. You can add additional validation by defining a JSONSchema specification. See http://json-schema.org/understanding-json-schema/reference/object.html for more information. - … - DAGLinkedInputAlias — An Alias for Linked Inputs. A linked input alias will be hidden in the UI and will be linked to an object in the UI using the input handler. - … - `required` boolean — A field to indicate if this input is required. This input needs to be set explicitly even when a default value is provided. - `spec` object — An optional JSON Schema specification to validate the input value. You can use validate_spec method to validate a value against the spec. - `value` object, required - `outputs` union[], required — The outputs produced by this step. - union - StepStringOutput — A String output. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Output name. - `description` string — Optional description for output. - `path` string, required — Path to the output file relative to where the function command is executed. - `required` boolean — A boolean to indicate if an artifact output is required. A False value makes the artifact optional. - `value` string, required - StepIntegerOutput — An integer output. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Output name. - `description` string — Optional description for output. - `path` string, required — Path to the output file relative to where the function command is executed. - `required` boolean — A boolean to indicate if an artifact output is required. A False value makes the artifact optional. - `value` integer, required - StepNumberOutput — A number output. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Output name. - `description` string — Optional description for output. - `path` string, required — Path to the output file relative to where the function command is executed. - `required` boolean — A boolean to indicate if an artifact output is required. A False value makes the artifact optional. - `value` number, required - StepBooleanOutput — The boolean type matches only two special values: True and False. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Output name. - `description` string — Optional description for output. - `path` string, required — Path to the output file relative to where the function command is executed. - `required` boolean — A boolean to indicate if an artifact output is required. A False value makes the artifact optional. - `value` boolean, required - StepFolderOutput — A folder output. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Output name. - `description` string — Optional description for output. - `path` string, required — Path to the output folder relative to where the function command is executed. - `required` boolean — A boolean to indicate if an artifact output is required. A False value makes the artifact optional. - `source` union, required — The path to source the file from. - HTTP — HTTP Source A web HTTP to an FTP server or an API for example. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `url` string, required — For a HTTP endpoint this can be http://climate.onebuilding.org. - S3 — S3 Source An S3 bucket artifact Source. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `key` string, required — The path inside the bucket to source artifacts from. - `endpoint` string, required — The HTTP endpoint to reach the S3 bucket. - `bucket` string, required — The name of the S3 bucket on the host server. - `credentials_path` string — Path to the file holding the AccessKey and SecretAccessKey to authenticate to the bucket. Assumes public bucket access if none are specified. - ProjectFolder — Project Folder Source This is the path to a folder where files and folders can be sourced. In the context of a desktop run Workflow this folder will correspond to a local folder. In the context of a workflow run on Pollination this folder will correspond to a Project scoped folder. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `path` string — The path to a folder where files and folders can be sourced. For a local filesystem this can be "C:\Users\me\jobs\test". - StepFileOutput — A file output. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Output name. - `description` string — Optional description for output. - `path` string, required — Path to the output file relative to where the function command is executed. - `required` boolean — A boolean to indicate if an artifact output is required. A False value makes the artifact optional. - `source` union, required — The path to source the file from. - HTTP — HTTP Source A web HTTP to an FTP server or an API for example. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `url` string, required — For a HTTP endpoint this can be http://climate.onebuilding.org. - S3 — S3 Source An S3 bucket artifact Source. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `key` string, required — The path inside the bucket to source artifacts from. - `endpoint` string, required — The HTTP endpoint to reach the S3 bucket. - `bucket` string, required — The name of the S3 bucket on the host server. - `credentials_path` string — Path to the file holding the AccessKey and SecretAccessKey to authenticate to the bucket. Assumes public bucket access if none are specified. - ProjectFolder — Project Folder Source This is the path to a folder where files and folders can be sourced. In the context of a desktop run Workflow this folder will correspond to a local folder. In the context of a workflow run on Pollination this folder will correspond to a Project scoped folder. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `path` string — The path to a folder where files and folders can be sourced. For a local filesystem this can be "C:\Users\me\jobs\test". - StepPathOutput — A file or a folder output. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Output name. - `description` string — Optional description for output. - `path` string, required — Path to the output file or folder relative to where the function command is executed. - `required` boolean — A boolean to indicate if an artifact output is required. A False value makes the artifact optional. - `source` union, required — The path to source the file from. - HTTP — HTTP Source A web HTTP to an FTP server or an API for example. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `url` string, required — For a HTTP endpoint this can be http://climate.onebuilding.org. - S3 — S3 Source An S3 bucket artifact Source. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `key` string, required — The path inside the bucket to source artifacts from. - `endpoint` string, required — The HTTP endpoint to reach the S3 bucket. - `bucket` string, required — The name of the S3 bucket on the host server. - `credentials_path` string — Path to the file holding the AccessKey and SecretAccessKey to authenticate to the bucket. Assumes public bucket access if none are specified. - ProjectFolder — Project Folder Source This is the path to a folder where files and folders can be sourced. In the context of a desktop run Workflow this folder will correspond to a local folder. In the context of a workflow run on Pollination this folder will correspond to a Project scoped folder. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `path` string — The path to a folder where files and folders can be sourced. For a local filesystem this can be "C:\Users\me\jobs\test". - StepArrayOutput — A JSON array output. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Output name. - `description` string — Optional description for output. - `path` string, required — Path to the output file relative to where the function command is executed. - `required` boolean — A boolean to indicate if an artifact output is required. A False value makes the artifact optional. - `items_type` 'Generic' | 'String' | 'Integer' | 'Number' | 'Boolean' | 'Array' | 'JSONObject' — Type enum for items in a list. Items can not be files or folder. For a list of files you should copy them to a folder and use FolderInput input instead of using ArrayInput. - `value` unknown[], required - unknown - StepJSONObjectOutput — A JSON object output. - `type` string - `annotations` object — An optional dictionary to add annotations to inputs. These annotations will be used by the client side libraries. - `name` string, required — Output name. - `description` string — Optional description for output. - `path` string, required — Path to the output file relative to where the function command is executed. - `required` boolean — A boolean to indicate if an artifact output is required. A False value makes the artifact optional. - `value` object, required - `message` string — Any message produced by the task. Usually error/debugging hints. - `started_at` string, date-time, required — The time at which the task was started - `finished_at` string, date-time — The time at which the task was completed - `source` string — Source url for the status object. It can be a recipe or a function. - `id` string, required — The step unique ID - `name` string, 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` 'Scheduled' | 'Running' | 'Failed' | 'Succeeded' | 'Skipped' | 'Unknown' — Enumaration of allowable status strings - `status_type` 'Function' | 'DAG' | 'Loop' | 'Container' | 'Unknown', required — Type enum for status type. - `template_ref` string, required — The name of the template that spawned this step - `command` string — The command used to run this step. Only applies to Function steps. - `boundary_id` string — 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. - `children_ids` string[], required — A list of child step IDs - `outbound_steps` string[], 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. ## Other responses - `422` — Validation Error --- [API](https://skmtc.net/pollination/apis/pollination-server.md) · [All operations](https://skmtc.net/pollination/apis/pollination-server/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pollination/pollination-server/revisions/c1f3c6d96b31/schema)