Step

Interface

Detailed information for a step in a diagram.

Properties

PropertyTypeNotes

Specific action for running this step.

boolean

Indicates whether this step will run automatically.

boolean

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

string

Color of the step.

string

Description of the step.

string

Link for help documentation.

string

Text for help documentation.

string

Url to help documentation.

string

Step Id.

string

Step name.

Paths in the diagram which connect steps together.

string

Position of the step on the diagram.

boolean

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

Schedule

Schedule for when the step should be run.

number

Shape of the step.

string

Id of the step template this step was created from.

action

Interface Property
action: StepAction

Specific action for running this step.

automatic

Interface Property
automatic: boolean

Indicates whether this step will run automatically.

canSkip

Interface Property
canSkip: boolean

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

color

optional
Interface Property
color: string

Color of the step.

description

optional
Interface Property
description: string

Description of the step.

optional
Interface Property
helpLink: string

Link for help documentation.

helpText

optional
Interface Property
helpText: string

Text for help documentation.

helpUrl

optional
Interface Property
helpUrl: string

Url to help documentation.

id

Interface Property
id: string

Step Id.

name

Interface Property
name: string

Step name.

paths

Interface Property
paths: StepPath[]

Paths in the diagram which connect steps together.

position

Interface Property
position: string

Position of the step on the diagram.

proceedNext

Interface Property
proceedNext: boolean

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

schedule

optional
Interface Property
schedule: Schedule

Schedule for when the step should be run.

shape

Interface Property
shape: number

Shape of the step.

stepTemplateId

optional
Interface Property
stepTemplateId: string

Id of the step template this step was created from.

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