workflowBase

The workflow base structure

JSON Example

{
    "name": "string",
    "version": "string",
    "startStepId": "string",
    "schemaVersion": "string",
    "owner": {
        "id": "string",
        "subId": "string",
        "type": "string"
    },
    "readOnly": false,
    "description": "string",
    "hierarchy": [
        "string"
    ],
    "tags": [
        {
            "name": "string",
            "autoCreated": false
        }
    ]
}

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

workflowOwner

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

array of object