Conditional result

Summary

id: string
meta: object
type: enum (step|split|join)
condition: # {condition}
transitions:
- # {transition}
- # {transition}
functions:
  pre:
  - # {function}
  - # {function}
  post:
  - # {function}
  - # {function}

Properties

Name	Required	Type	Description
id	true	string	Identifier of the registered condition class to use
meta	false	object	Arbitrary data to help describe your condition. Not used by the engine.
type	true	string	Indicates what this result will do to the flow. Either a simple step change, a split or a join.
condition	true	object	A condition object defining the condition that must be true in order for this result to be used.
functions.pre	false	array	Array of function objects that will be executed before the transitions take place.
functions.post	false	array	Array of function objects that will be executed after the transitions take place.
transitions	true	array	Array of transition objects that define the change of step statuses that effectively allow instances to move through the flow.

JSON schema

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "conditionalResult.schema.json",
    "type": "object",
    "title": "Workflow result (conditional)",
    "required":[ "id", "type", "condition", "transitions" ],
    "additionalProperties": false,
    "properties":{
        "id"    : { "type":"string", "description":"Unique identifier for the result within the action" },
        "meta" : { "type":"object", "description":"Abitrary metadata that you may use to describe the result."},
        "type":{
            "type":"string",
            "description":"Describes the type of this result. Either 'step', 'join' or 'split'",
            "enum":[ "step", "join", "split" ]
        },
        "condition":{
            "type":"object",
            "description":"Condition that must evaluate to true in order for this conditional result to be chosen",
            "$ref":"condition.schema.json"
        },
        "functions":{
            "type":"object",
            "description":"Pre and post functions that execute before and after this result is executed.",
            "$ref":"functions.schema.json"
        },
        "transitions":{
            "type":"array",
            "minItems":1,
            "description":"Array of step status transitions that this result actions when executed.",
            "items":{
                "type":"object",
                "$ref":"transition.schema.json"
            }
        }
    }
}