schema
stringclasses 471
values | key
stringlengths 0
203
| description
stringlengths 0
4.37k
| object
stringlengths 2
322k
|
|---|---|---|---|
workflow.json | stateDataFilter | State data filter | {} |
workflow.json | timeouts | State specific timeouts | {"type": "object", "properties": {"stateExecTimeout": {}, "branchExecTimeout": {}}, "required": []} |
workflow.json | branches | Branch Definitions | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | completionType | Option types on how to complete branch execution. | {"type": "string", "enum": ["allOf", "atLeast"], "default": "allOf"} |
workflow.json | numCompleted | Used when completionType is set to 'atLeast' to specify the minimum number of branches that must complete before the state will transition. | {"type": ["number", "string"], "minimum": 0, "minLength": 0} |
workflow.json | onErrors | States error handling definitions | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | transition | Next transition of the workflow after all branches have completed execution | {} |
workflow.json | compensatedBy | Unique Name of a workflow state which is responsible for compensation of this state | {"type": "string", "minLength": 1} |
workflow.json | usedForCompensation | If true, this state is used to compensate another state. Default is false | {"type": "boolean", "default": false} |
workflow.json | eventbasedswitchstate | Permits transitions to other states based on events | {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "switch"}, "stateDataFilter": {}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}, "eventTimeout": {}}, "required": []}, "eventConditions": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "defaultCondition": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "metadata": {}}, "additionalProperties": false, "required": ["name", "type", "eventConditions", "defaultCondition"]} |
workflow.json | name | State name | {"type": "string"} |
workflow.json | type | State type | {"type": "string", "const": "switch"} |
workflow.json | stateDataFilter | State data filter | {} |
workflow.json | timeouts | State specific timeouts | {"type": "object", "properties": {"stateExecTimeout": {}, "eventTimeout": {}}, "required": []} |
workflow.json | eventConditions | Defines conditions evaluated against events | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | onErrors | States error handling definitions | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | defaultCondition | Default transition of the workflow if there is no matching data conditions. Can include a transition or end definition | {} |
workflow.json | compensatedBy | Unique Name of a workflow state which is responsible for compensation of this state | {"type": "string", "minLength": 1} |
workflow.json | usedForCompensation | If true, this state is used to compensate another state. Default is false | {"type": "boolean", "default": false} |
workflow.json | databasedswitchstate | Permits transitions to other states based on data conditions | {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "switch"}, "stateDataFilter": {}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}}, "required": []}, "dataConditions": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "defaultCondition": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "metadata": {}}, "additionalProperties": false, "required": ["name", "type", "dataConditions", "defaultCondition"]} |
workflow.json | name | State name | {"type": "string"} |
workflow.json | type | State type | {"type": "string", "const": "switch"} |
workflow.json | stateDataFilter | State data filter | {} |
workflow.json | timeouts | State specific timeouts | {"type": "object", "properties": {"stateExecTimeout": {}}, "required": []} |
workflow.json | dataConditions | Defines conditions evaluated against state data | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | onErrors | States error handling definitions | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | defaultCondition | Default transition of the workflow if there is no matching data conditions. Can include a transition or end definition | {} |
workflow.json | compensatedBy | Unique Name of a workflow state which is responsible for compensation of this state | {"type": "string", "minLength": 1} |
workflow.json | usedForCompensation | If true, this state is used to compensate another state. Default is false | {"type": "boolean", "default": false} |
workflow.json | defaultconditiondef | DefaultCondition definition. Can be either a transition or end definition | {"type": "object", "properties": {"name": {"type": "string"}, "transition": {}, "end": {}}, "additionalProperties": false, "oneOf": [{"required": ["transition"]}, {"required": ["end"]}]} |
workflow.json | name | The optional name of the default condition, used solely for display purposes | {"type": "string"} |
workflow.json | transitioneventcondition | Switch state data event condition | {"type": "object", "properties": {"name": {"type": "string"}, "eventRef": {"type": "string"}, "transition": {}, "eventDataFilter": {}, "metadata": {}}, "additionalProperties": false, "required": ["eventRef", "transition"]} |
workflow.json | name | Event condition name | {"type": "string"} |
workflow.json | eventRef | References an unique event name in the defined workflow events | {"type": "string"} |
workflow.json | transition | Next transition of the workflow if there is valid matches | {} |
workflow.json | eventDataFilter | Event data filter definition | {} |
workflow.json | endeventcondition | Switch state data event condition | {"type": "object", "properties": {"name": {"type": "string"}, "eventRef": {"type": "string"}, "end": {}, "eventDataFilter": {}, "metadata": {}}, "additionalProperties": false, "required": ["eventRef", "end"]} |
workflow.json | name | Event condition name | {"type": "string"} |
workflow.json | eventRef | References an unique event name in the defined workflow events | {"type": "string"} |
workflow.json | end | Explicit transition to end | {} |
workflow.json | eventDataFilter | Event data filter definition | {} |
workflow.json | transitiondatacondition | Switch state data based condition | {"type": "object", "properties": {"name": {"type": "string"}, "condition": {"type": "string"}, "transition": {}, "metadata": {}}, "additionalProperties": false, "required": ["condition", "transition"]} |
workflow.json | name | Data condition name | {"type": "string"} |
workflow.json | condition | Workflow expression evaluated against state data. Must evaluate to true or false | {"type": "string"} |
workflow.json | transition | Workflow transition if condition is evaluated to true | {} |
workflow.json | enddatacondition | Switch state data based condition | {"type": "object", "properties": {"name": {"type": "string"}, "condition": {"type": "string"}, "end": {}, "metadata": {}}, "additionalProperties": false, "required": ["condition", "end"]} |
workflow.json | name | Data condition name | {"type": "string"} |
workflow.json | condition | Workflow expression evaluated against state data. Must evaluate to true or false | {"type": "string"} |
workflow.json | end | Workflow end definition | {} |
workflow.json | injectstate | Inject static data into state data. Does not perform any actions | {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "inject"}, "end": {}, "data": {"type": "object"}, "stateDataFilter": {}, "transition": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "metadata": {}}, "additionalProperties": false, "if": {"properties": {"usedForCompensation": {"const": true}}, "required": ["usedForCompensation"]}, "then": {"required": ["name", "type", "data"]}, "else": {"oneOf": [{"required": ["name", "type", "data", "end"]}, {"required": ["name", "type", "data", "transition"]}]}} |
workflow.json | name | State name | {"type": "string"} |
workflow.json | type | State type | {"type": "string", "const": "inject"} |
workflow.json | end | State end definition | {} |
workflow.json | data | JSON object which can be set as states data input and can be manipulated via filters | {"type": "object"} |
workflow.json | stateDataFilter | State data filter | {} |
workflow.json | transition | Next transition of the workflow after injection has completed | {} |
workflow.json | compensatedBy | Unique Name of a workflow state which is responsible for compensation of this state | {"type": "string", "minLength": 1} |
workflow.json | usedForCompensation | If true, this state is used to compensate another state. Default is false | {"type": "boolean", "default": false} |
workflow.json | foreachstate | Execute a set of defined actions or workflows for each element of a data array | {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "foreach"}, "end": {}, "inputCollection": {"type": "string"}, "outputCollection": {"type": "string"}, "iterationParam": {"type": "string"}, "batchSize": {"type": ["number", "string"], "minimum": 0, "minLength": 0}, "actions": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}, "actionExecTimeout": {}}, "required": []}, "stateDataFilter": {}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "transition": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "mode": {"type": "string", "enum": ["sequential", "parallel"], "default": "parallel"}, "metadata": {}}, "additionalProperties": false, "if": {"properties": {"usedForCompensation": {"const": true}}, "required": ["usedForCompensation"]}, "then": {"required": ["name", "type", "inputCollection", "actions"]}, "else": {"oneOf": [{"required": ["name", "type", "inputCollection", "actions", "end"]}, {"required": ["name", "type", "inputCollection", "actions", "transition"]}]}} |
workflow.json | name | State name | {"type": "string"} |
workflow.json | type | State type | {"type": "string", "const": "foreach"} |
workflow.json | end | State end definition | {} |
workflow.json | inputCollection | Workflow expression selecting an array element of the states data | {"type": "string"} |
workflow.json | outputCollection | Workflow expression specifying an array element of the states data to add the results of each iteration | {"type": "string"} |
workflow.json | iterationParam | Name of the iteration parameter that can be referenced in actions/workflow. For each parallel iteration, this param should contain an unique element of the inputCollection array | {"type": "string"} |
workflow.json | batchSize | Specifies how many iterations may run in parallel at the same time. Used if 'mode' property is set to 'parallel' (default) | {"type": ["number", "string"], "minimum": 0, "minLength": 0} |
workflow.json | actions | Actions to be executed for each of the elements of inputCollection | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | timeouts | State specific timeouts | {"type": "object", "properties": {"stateExecTimeout": {}, "actionExecTimeout": {}}, "required": []} |
workflow.json | stateDataFilter | State data filter | {} |
workflow.json | onErrors | States error handling definitions | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | transition | Next transition of the workflow after state has completed | {} |
workflow.json | compensatedBy | Unique Name of a workflow state which is responsible for compensation of this state | {"type": "string", "minLength": 1} |
workflow.json | usedForCompensation | If true, this state is used to compensate another state. Default is false | {"type": "boolean", "default": false} |
workflow.json | mode | Specifies how iterations are to be performed (sequentially or in parallel) | {"type": "string", "enum": ["sequential", "parallel"], "default": "parallel"} |
workflow.json | callbackstate | This state performs an action, then waits for the callback event that denotes completion of the action | {"type": "object", "properties": {"name": {"type": "string"}, "type": {"type": "string", "const": "callback"}, "action": {}, "eventRef": {"type": "string"}, "timeouts": {"type": "object", "properties": {"stateExecTimeout": {}, "actionExecTimeout": {}, "eventTimeout": {}}, "required": []}, "eventDataFilter": {}, "stateDataFilter": {}, "onErrors": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "transition": {}, "end": {}, "compensatedBy": {"type": "string", "minLength": 1}, "usedForCompensation": {"type": "boolean", "default": false}, "metadata": {}}, "additionalProperties": false, "if": {"properties": {"usedForCompensation": {"const": true}}, "required": ["usedForCompensation"]}, "then": {"required": ["name", "type", "action", "eventRef"]}, "else": {"oneOf": [{"required": ["name", "type", "action", "eventRef", "end"]}, {"required": ["name", "type", "action", "eventRef", "transition"]}]}} |
workflow.json | name | State name | {"type": "string"} |
workflow.json | type | State type | {"type": "string", "const": "callback"} |
workflow.json | action | Defines the action to be executed | {} |
workflow.json | eventRef | References an unique callback event name in the defined workflow events | {"type": "string"} |
workflow.json | timeouts | State specific timeouts | {"type": "object", "properties": {"stateExecTimeout": {}, "actionExecTimeout": {}, "eventTimeout": {}}, "required": []} |
workflow.json | eventDataFilter | Event data filter | {} |
workflow.json | stateDataFilter | State data filter | {} |
workflow.json | onErrors | States error handling definitions | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | transition | Next transition of the workflow after all the actions have been performed | {} |
workflow.json | end | State end definition | {} |
workflow.json | compensatedBy | Unique Name of a workflow state which is responsible for compensation of this state | {"type": "string", "minLength": 1} |
workflow.json | usedForCompensation | If true, this state is used to compensate another state. Default is false | {"type": "boolean", "default": false} |
workflow.json | startdef | Name of the starting workflow state | {"type": "string", "minLength": 1} |
workflow.json | startdef | Workflow start definition | {"type": "object", "properties": {"stateName": {"type": "string", "minLength": 1}, "schedule": {}}, "additionalProperties": false, "required": ["schedule"]} |
workflow.json | stateName | Name of the starting workflow state | {"type": "string", "minLength": 1} |
workflow.json | schedule | Define the time/repeating intervals or cron at which workflow instances should be automatically started. | {} |
workflow.json | schedule | Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created. (UTC timezone is assumed) | {"type": "string", "minLength": 1} |
workflow.json | schedule | Start state schedule definition | {"type": "object", "properties": {"interval": {"type": "string", "minLength": 1}, "cron": {}, "timezone": {"type": "string"}}, "additionalProperties": false, "oneOf": [{"required": ["interval"]}, {"required": ["cron"]}]} |
workflow.json | interval | Time interval (must be repeating interval) described with ISO 8601 format. Declares when workflow instances will be automatically created. | {"type": "string", "minLength": 1} |
workflow.json | timezone | Timezone name used to evaluate the interval & cron-expression. (default: UTC) | {"type": "string"} |
workflow.json | end | State end definition | {"type": "boolean", "default": true} |
workflow.json | end | State end definition | {"type": "object", "properties": {"terminate": {"type": "boolean", "default": false}, "produceEvents": {"type": "array", "items": {"type": "object"}, "additionalItems": false}, "compensate": {"type": "boolean", "default": false}, "continueAs": {}}, "additionalProperties": false, "required": []} |
workflow.json | terminate | If true, completes all execution flows in the given workflow instance | {"type": "boolean", "default": false} |
workflow.json | produceEvents | Defines events that should be produced | {"type": "array", "items": {"type": "object"}, "additionalItems": false} |
workflow.json | compensate | If set to true, triggers workflow compensation. Default is false | {"type": "boolean", "default": false} |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.