Function

Summary

ref: string
meta: object
args: object
condition: # {condition}

Properties

Name	Required	Type	Description
ref	true	string	Identifier of the registered function class to use
meta	false	object	Arbitrary data to help describe your function. Not used by the engine.
args	false	object	Arbitrary data to pass to the function class when executing
condition	false	object	condition object representing the condition(s) that must be true in order for this function to be executed

JSON schema

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "function.schema.json",
    "type": "object",
    "title": "Workflow function",
    "additionalProperties": false,
    "required":["ref"],
    "properties":{
        "ref":{ "type":"string", "description":"ID of function that has been registered with the workflow engine." },
        "meta":{ "type":"object", "description":"Abitrary meta data that you may use to describe the function."},
        "args":{"type":"object", "description":"Abitrary object of data that will be passed to the function handler when executued (along with the instance state, etc.)" },
        "condition":{
            "type":"object",
            "description":"Optional condition object that will determine whether or not the function is executed",
            "$ref":"condition.schema.json"
        }
    }
}