Skip to content

Interface

Detailed information for a step in a diagram.

Properties

PropertyTypeNotes
actionStepAction

Specific action for running this step.

automaticboolean

Indicates whether this step will run automatically.

canSkipboolean

Indicates whether the step can be completed without it first being run.

colorstring

Color of the step.

descriptionstring

Description of the step.

helpLinkstring

Link for help documentation.

helpTextstring

Text for help documentation.

helpUrlstring

Url to help documentation.

idstring

Step Id.

namestring

Step name.

pathsStepPath[]

Paths in the diagram which connect steps together.

positionstring

Position of the step on the diagram.

proceedNextboolean

Indicates whether the workflow should proceed to the next step in the diagram after completion of this step.

scheduleSchedule

Schedule for when the step should be run.

shapenumber

Shape of the step.

stepTemplateIdstring

Id of the step template this step was created from.

action

Interface Property

automatic

Interface Property

canSkip

Interface Property

color

optional
Interface Property

description

optional
Interface Property
optional
Interface Property

helpText

optional
Interface Property

helpUrl

optionaldeprecated
Interface Property

id

Interface Property

name

Interface Property

paths

Interface Property

position

Interface Property

proceedNext

Interface Property

schedule

optional
Interface Property

shape

Interface Property

stepTemplateId

optional
Interface Property

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.