Workflow Schema

docs.neops.io/schema/RootWorkflow#/definitions/Workflow

Represents a workflow schema, which includes steps and execution configuration

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	No	Forbidden	Forbidden	none	RootWorkflow.schema.json*

Workflow Type

object (Workflow)

Workflow Properties

Property	Type	Required	Nullable	Defined by
condition	`string`	Optional	cannot be null	Root Workflow
config	`object`	Required	cannot be null	Root Workflow
continueOnError	`boolean`	Optional	cannot be null	Root Workflow
delay	`number`	Optional	can be null	Root Workflow
id	`string`	Required	cannot be null	Root Workflow
name	`string`	Required	cannot be null	Root Workflow
parameters	`object`	Required	cannot be null	Root Workflow
repeatConfig	Merged	Optional	cannot be null	Root Workflow
retryConfig	Merged	Optional	cannot be null	Root Workflow
runOn	`string`	Optional	cannot be null	Root Workflow
steps	`array`	Required	cannot be null	Root Workflow
type	`string`	Required	cannot be null	Root Workflow

condition

A JMESPath expression that evaluates to a boolean value

condition

is optional
Type: string (Condition)
cannot be null
defined in: Root Workflow

condition Type

string (Condition)

condition Examples

"devices[?state=='active']"

config

Configuration settings for a workflow execution

config

is required
Type: object (Workflow Configuration)
cannot be null
defined in: Root Workflow

config Type

object (Workflow Configuration)

continueOnError

Whether to continue workflow execution if this step fails. When true, workflow will proceed to next step even if current step fails.

continueOnError

is optional
Type: boolean (Continue On Error)
cannot be null
defined in: Root Workflow

continueOnError Type

boolean (Continue On Error)

continueOnError Examples

false

delay

Delay in seconds before executing this step. Useful for rate limiting or scheduling steps to run after a certain time.

delay

is optional
Type: number (Execution Delay)
can be null
defined in: Root Workflow

delay Type

number (Execution Delay)

delay Constraints

minimum: the value of this number must greater than or equal to: 0

delay Examples

id

Unique identifier for this step configuration. Set explicitly to access the result object on a subsequent step.

id

is required
Type: string (Step ID)
cannot be null
defined in: Root Workflow

id Type

string (Step ID)

id Default Value

The default value is:

"random UUID"

id Examples

"ping"

"550e8400-e29b-41d4-a716-446655440000"

name

Human-readable name for this step

name

is required
Type: string (Step Name)
cannot be null
defined in: Root Workflow

name Type

string (Step Name)

name Constraints

maximum length: the maximum number of characters for this string is: 100

minimum length: the minimum number of characters for this string is: 1

name Examples

"Check Interface Status"

parameters

Key-value pairs of parameters to pass to the step during execution. Supports dynamic values through JMESPath expressions enclosed in double curly braces. Parameters are specific to each step type and implementation.

parameters

is required
Type: object (Step Parameters)
cannot be null
defined in: Root Workflow

parameters Type

object (Step Parameters)

parameters Default Value

The default value is:

{}

repeatConfig

Optional settings for repeating the step execution multiple times. Null if not repeating.

repeatConfig

is optional
Type: merged type (Repeat Configuration)
cannot be null
defined in: Root Workflow

repeatConfig Type

merged type (Repeat Configuration)

any of

retryConfig

Retry behavior configuration when step fails

retryConfig

is optional
Type: merged type (Retry Configuration)
cannot be null
defined in: Root Workflow

retryConfig Type

merged type (Retry Configuration)

any of

runOn

Types of entities that workflows can operate on

runOn

is optional
Type: string (Entity Type)
cannot be null
defined in: Root Workflow

runOn Type

string (Entity Type)

runOn Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
`"global"`
`"device"`
`"interface"`
`"group"`
`"client"`

steps

The sequence of steps that comprise this workflow. Each step can be a function block, embedded workflow, or reference to another workflow. At least one step is required.

steps

is required
Type: object[] (Workflow Step)
cannot be null
defined in: Root Workflow

steps Type

object[] (Workflow Step)

steps Constraints

minimum number of items: the minimum number of items for this array is: 1

type

The type of workflow step. For workflows this is always "workflow"

type

is required
Type: string (Type)
cannot be null
defined in: Root Workflow

type Type

string (Type)

type Constraints

constant: the value of this property must be equal to:

"workflow"

type Examples

"workflow"