Skip to content

Workflow Schema

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

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*

WorkflowAsStep Type

object (Workflow)

WorkflowAsStep Properties

Property Type Required Nullable Defined by
acquire array Optional cannot be null Root Workflow
assert array Optional can be null Root Workflow
condition object Optional cannot be null Root Workflow
config object Optional cannot be null Root Workflow
continueOnError boolean Optional cannot be null Root Workflow
delay number Optional can be null Root Workflow
description string Optional cannot be null Root Workflow
label string Required cannot be null Root Workflow
name string Required cannot be null Root Workflow
parameters object Optional cannot be null Root Workflow
rawParameters object Optional 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

acquire

Defines which entity/entities to acquire for this step.

acquire

acquire Type

an array of merged types (Details)

assert

Optional list of JMESPath assertions that must be satisfied for the step to execute. If any condition evaluates to false, the step will fail.

assert

assert Type

object[] (Details)

condition

Represents a condition based on a jmes expression that evaluates to true/false.

condition

condition Type

object (Details)

config

Configuration settings for a workflow execution

config

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

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

delay Type

number (Execution Delay)

delay Constraints

maximum: the value of this number must smaller than or equal to: 600

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

delay Examples

60

description

Human-readable description for this step

description

description Type

string (Step Description)

description Constraints

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

description Examples

"Check Interface Status"

label

Unique label for a step. Set explicitly to access the result object on a subsequent step.

label

label Type

string (Label)

label Constraints

pattern: the string must match the following regular expression: 

^\w+$

try pattern

label Examples

"ping"

"ping_new"

name

Human-readable name for this workflow.

name

name Type

string (Workflow 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

"ping_workflow"

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

parameters Type

object (Step Parameters)

parameters Default Value

The default value is:

{}

rawParameters

Key-value pairs of raw parameters to pass to the step during execution. Will be merged with interpolated parameters, with raw parameters taking precedence. Parameters are specific to each step type and implementation.

rawParameters

rawParameters Type

object (Raw Step Parameters (not interpolated))

rawParameters Default Value

The default value is:

{}

repeatConfig

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

repeatConfig

repeatConfig Type

merged type (Repeat Configuration)

any of

retryConfig

Retry behavior configuration when step fails

retryConfig

retryConfig Type

merged type (Retry Configuration)

any of

runOn

Types of entities that workflows can operate on

runOn

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

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

type Type

string (Type)

type Constraints

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

"workflow"

type Examples

"workflow"