Define Workflow Parameters

You can use input and output parameters to pass data in and out of the workflow.

The input parameters are the initial data the workflow requires to run. You provide the values for the input parameters when you run the workflow. The output parameters are the data the workflow returns when it finishes its execution.

Parameter Example

{
    "name": "vmName",
    "description": "The description of the variable",
    "type": "string",
    "default":"vm-32",
    "value":"vm-32"
}

Parameter Schema

{
    "$schema": "http://json-schema.org/draft-07/schema",
    "$id": "http://example.com/example.json",
    "type": "object",
    "readOnly": false,
    "writeOnly": false,
    "minProperties": 0,
    "title": "The Root Schema",
    "description": "The root schema comprises the entire JSON document.",
    "additionalProperties": true,
    "required": [
        "name",
        "type"
    ],
    "properties": {
        "name": {
            "$id": "#/properties/name",
            "type": "string",
            "readOnly": false,
            "writeOnly": false,
            "minLength": 0,
            "title": "The Name Schema",
            "description": "An explanation about the purpose of this instance.",
            "default": "",
            "examples": [
                "vmName"
            ]
        },
        "description": {
            "$id": "#/properties/description",
            "type": "string",
            "readOnly": false,
            "writeOnly": false,
            "minLength": 0,
            "title": "The Description Schema",
            "description": "An explanation about the purpose of this instance.",
            "default": "",
            "examples": [
                "The description of the variable"
            ]
        },
        "type": {
            "$id": "#/properties/type",
            "type": "string",
            "readOnly": false,
            "writeOnly": false,
            "minLength": 0,
            "title": "The Type Schema",
            "description": "An explanation about the purpose of this instance.",
            "default": "",
            "examples": [
                "string",
                "boolean",
                "number"
            ]
        },
        "default": {
            "$id": "#/properties/default",
            "type": "string",
            "readOnly": false,
            "writeOnly": false,
            "minLength": 0,
            "title": "The Default Schema",
            "description": "An explanation about the purpose of this instance.",
            "default": "",
            "examples": [
                "vm-32"
            ]
        },
        "value": {
            "$id": "#/properties/value",
            "type": "string",
            "readOnly": false,
            "writeOnly": false,
            "minLength": 0,
            "title": "The Value Schema",
            "description": "An explanation about the purpose of this instance.",
            "default": "",
            "examples": [
                "vm-32"
            ]
        }
    }
}