Workflow Reference Schema

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

Represents a reference to another workflow that can be included in a workflow definition

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*

WorkflowReference Type

object (Workflow Reference)

WorkflowReference 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
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
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
strategy	`string`	Required	cannot be null	Root Workflow
type	`string`	Required	cannot be null	Root Workflow
workflow	`string`	Required	cannot be null	Root Workflow

acquire

Defines which entity/entities to acquire for this step.

acquire

is optional
Type: an array of merged types (Details)
cannot be null
defined in: Root Workflow

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

is optional
Type: object[] (Details)
can be null
defined in: Root Workflow

assert Type

object[] (Details)

condition

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

condition

is optional
Type: object (Details)
cannot be null
defined in: Root Workflow

condition Type

object (Details)

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

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

description

Human-readable description for this step

description

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

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

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

label Type

string (Label)

label Constraints

pattern: the string must match the following regular expression:

^\w+$

try pattern

label Examples

"ping"

"ping_new"

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 optional
Type: object (Step Parameters)
cannot be null
defined in: Root Workflow

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

is optional
Type: object (Raw Step Parameters (not interpolated))
cannot be null
defined in: Root Workflow

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

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"`

strategy

Execution strategy for referenced workflow

strategy

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

strategy Type

string (Execution Strategy)

strategy Constraints

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

Value	Explanation
`"dispatch"`
`"embed"`

strategy Examples

"dispatch"

"embed"

type

The type discriminator for this workflow step

type

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

type Type

string (Step Type)

type Constraints

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

"workflowReference"

type Examples

"workflowReference"

workflow

A SemVer identifier of the workflow being referenced

workflow

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

workflow Type

string (Referenced Workflow)

workflow Constraints

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

workflow Examples

"wf.neops.io/ping:1.0.0"