Interface
Detailed information for a step in a diagram.
Properties
| Property | Type | Notes |
|---|---|---|
action | StepAction | Specific action for running this step. |
automatic | boolean | Indicates whether this step will run automatically. |
canSkip | boolean | Indicates whether the step can be completed without it first being run. |
color | string | Color of the step. |
description | string | Description of the step. |
helpLink | string | Link for help documentation. |
helpText | string | Text for help documentation. |
helpUrl | string | Url to help documentation. |
id | string | Step Id. |
name | string | Step name. |
paths | StepPath[] | Paths in the diagram which connect steps together. |
position | string | Position of the step on the diagram. |
proceedNext | boolean | Indicates whether the workflow should proceed to the next step in the diagram after completion of this step. |
schedule | Schedule | Schedule for when the step should be run. |
shape | number | Shape of the step. |
stepTemplateId | string | Id of the step template this step was created from. |
action
Interface Propertyaction: StepActionSpecific action for running this step.
canSkip
Interface PropertycanSkip: booleanIndicates whether the step can be completed without it first being run.
paths
Interface Propertypaths: StepPath[]Paths in the diagram which connect steps together.