workflowBase

workflowBase
workflowBase

The workflow base structure

JSON Example
{
    "owner": {
        "subId": "subId",
        "id": "id"
    },
    "outputs": {
        "key": {
            "defaultValue": "{}",
            "format": "format",
            "description": "description"
        }
    },
    "variables": {
        "key": {
            "defaultValue": "{}",
            "format": "format",
            "description": "description"
        }
    },
    "schemaVersion": "schemaVersion",
    "attachments": {
        "key": {
            "reference": true,
            "id": "id"
        }
    },
    "inputs": {
        "key": {
            "defaultValue": "{}",
            "format": "format",
            "description": "description",
            "required": true
        }
    },
    "hierarchy": [
        "hierarchy",
        "hierarchy"
    ],
    "description": "description",
    "readOnly": true,
    "version": "version",
    "steps": {
        "key": {
            "nextStepId": "nextStepId",
            "description": "description",
            "inBindings": {
                "key": {
                    "defaultValue": "{}",
                    "format": "format",
                    "exportName": "exportName"
                }
            },
            "conditions": [
                {
                    "name": "name",
                    "nextStepId": "nextStepId",
                    "value": "{}"
                },
                {
                    "name": "name",
                    "nextStepId": "nextStepId",
                    "value": "{}"
                }
            ],
            "outBindings": {
                "key": {
                    "name": "name",
                    "format": "format"
                }
            }
        }
    },
    "tags": [
        {
            "name": "name",
            "autoCreated": true
        },
        {
            "name": "name",
            "autoCreated": true
        }
    ],
    "startStepId": "startStepId",
    "name": "name"
}
string
name
Required

The name of the workflow

string
version
Required

The version of the workflow

string
startStepId
Optional

The identifier of the starting step

string
schemaVersion
Required

The schema version of the workflow

owner
Required

owner

boolean
readOnly
Required

Can the workflow be modified

string
description
Optional

The description of the workflow

object
inputs
Optional

The inputs of the workflow

object
outputs
Optional

The outputs of the workflow

object
variables
Optional

The variables of the workflow

array of string
hierarchy
Optional

The hierarchical location of the workflow

tags
Optional

The tags of the workflow

object
attachments
Optional

The file attachments of the workflow

object
steps
Optional

The steps of the workflow

Used By
Parameter To
Returned By