Datamanager flow JSON Schema: Initial action

InitialAction

The initialAction object represents an action that is triggered as soon as a record's workflow state is created. These actions are used to activate relevant starting steps for the flow and execute any other result logic that you need to fire.

Summary

initialActions:
  - id: defaultAction
    result:
      # default result object
    condition:
      # optional condition option
    conditionalResults:
      # optional array of conditional results, first matching result will be fired

Properties

Name	Required	Type	Description
`id`	`true`	`string`	Unique identifier for the step within the flow
`result`	`true`	`object`	A default result object specifying what step transitions to execute
`condition`	`false`	`array`	A condition object. If defined, the condition must evaluate to true before any other conditional initial actions for this action to be executed.
`conditionalResults`	`false`	`array`	Array of conditionalResult objects

JSON schema

{
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "datamanager.initialaction.schema.json",
    "type": "object",
    "title": "Action",
    "additionalProperties": false,
    "required":[ "id", "result" ],
    "properties":{
        "id"                 : { "type":"string", "description":"Unique ID of the action (unique to the set of initial actions)" },
        "condition"          : { "type":"object", "description":"Optional condition that must be true in order for the action to be run", "$ref":"datamanager.condition.schema.json"},
        "result"             : { "type":"object", "description":"The default result to run if no conditional results are defined or matched", "$ref":"datamanager.result.schema.json"},
        "conditionalResults" : { "type":"array" , "description":"Optional array of conditional results to run should their condition be matched. First matching result wins.", "items":{ "type":"object", "$ref":"datamanager.conditionalresult.schema.json" } }
    }
}