Skip to content

Root Workflow Schema

docs.neops.io/schema/RootWorkflow

Represents the root workflow schema, which includes metadata and configuration

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

Root Workflow Type

object (Root Workflow)

Root Workflow Properties

Property Type Required Nullable Defined by
$schema string Optional cannot be null Root Workflow
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
cron array Optional cannot be null Root Workflow
delay number Optional can be null Root Workflow
description string Optional cannot be null Root Workflow
hideForExecution boolean Optional cannot be null Root Workflow
label string Required cannot be null Root Workflow
majorVersion number Required cannot be null Root Workflow
minorVersion number Required cannot be null Root Workflow
name string Required cannot be null Root Workflow
package string Required cannot be null Root Workflow
parameterSchema object Optional cannot be null Root Workflow
parameters object Optional cannot be null Root Workflow
patchVersion number Required 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
seedEntity string Required cannot be null Root Workflow
steps array Required cannot be null Root Workflow
type string Required cannot be null Root Workflow

$schema

The JSON schema URI that this document conforms to

$schema

$schema Type

string (Schema URI)

$schema Constraints

URI: the string must be a URI, according to RFC 3986

$schema Examples

"http://json-schema.org/draft-07/schema#"

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

cron

Cron schedule configurations for the workflow

cron

cron Type

object[] (Cron Configuration)

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"

hideForExecution

hideForExecution

  • is optional

  • Type: boolean

  • cannot be null

  • defined in: Root Workflow

hideForExecution Type

boolean

label

Unique label for the workflow to be able to reference its parameters and result

label

label Type

string (Label)

label Constraints

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

pattern: the string must match the following regular expression: 

^\w+$

try pattern

label Examples

"workflow42"

"backup_workflow"

majorVersion

Major version number (following semantic versioning)

majorVersion

  • is required

  • Type: number

  • cannot be null

  • defined in: Root Workflow

majorVersion Type

number

majorVersion Examples

1

minorVersion

Minor version number (following semantic versioning)

minorVersion

  • is required

  • Type: number

  • cannot be null

  • defined in: Root Workflow

minorVersion Type

number

minorVersion Examples

2

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"

package

The package/namespace the versionable entity belongs to

package

  • is required

  • Type: string

  • cannot be null

  • defined in: Root Workflow

package Type

string

package Examples

"wf.neops.io"

parameterSchema

parameterSchema

parameterSchema Type

object (Details)

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:

{}

patchVersion

Patch version number (following semantic versioning)

patchVersion

  • is required

  • Type: number

  • cannot be null

  • defined in: Root Workflow

patchVersion Type

number

patchVersion Examples

3

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"

seedEntity

Types of entities that workflows can operate on

seedEntity

seedEntity Type

string (Entity Type)

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

Root Workflow Definitions

Definitions group ConditionType

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/ConditionType"}
Property Type Required Nullable Defined by
description string Optional cannot be null Root Workflow
jmes Multiple Required cannot be null Root Workflow
type string Required cannot be null Root Workflow

description

description

  • is optional

  • Type: string

  • cannot be null

  • defined in: Root Workflow

description Type

string

jmes

jmes

  • is required

  • Type: any of the following: string or boolean (Details)

  • cannot be null

  • defined in: Root Workflow

jmes Type

any of the following: string or boolean (Details)

type

type

  • is required

  • Type: string

  • cannot be null

  • defined in: Root Workflow

type Type

string

type Constraints

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

"jmes"

Definitions group CronConfiguration

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/CronConfiguration"}
Property Type Required Nullable Defined by
concurrency boolean Required cannot be null Root Workflow
condition object Optional cannot be null Root Workflow
crontab object Required cannot be null Root Workflow
description string Required cannot be null Root Workflow
enabled boolean Required cannot be null Root Workflow
parameters object Optional cannot be null Root Workflow
query string Required cannot be null Root Workflow
title string Required cannot be null Root Workflow

concurrency

Whether multiple instances of this scheduled job can run simultaneously

concurrency

concurrency Type

boolean (Allow Concurrency)

concurrency Examples

false

condition

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

condition

condition Type

object (Details)

crontab

Configuration for cron-style scheduling following standard cron syntax with seconds precision.

crontab

crontab Type

object (Crontab Configuration)

crontab Examples

{
  "dayOfMonth": "*",
  "dayOfWeek": "1-5",
  "hour": "9",
  "minute": "30",
  "month": "*",
  "second": "0",
  "timezone": "America/New_York"
}

description

Human-readable description of this scheduled job

description

description Type

string (Description)

description Constraints

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

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

description Examples

"Daily backup of core routers"

enabled

Whether this scheduled job is active and should be executed

enabled

enabled Type

boolean (Enabled)

enabled Examples

true

parameters

Key-value pairs of parameters that will be passed to the workflow execution

parameters

parameters Type

object (Execution Parameters)

parameters Constraints

minimum number of properties: the minimum number of properties for this object is: 1

parameters Examples

{
  "backupType": "full",
  "retentionDays": 7
}

query

Represents an Elasticsearch query in string format.

query

query Type

string (Elasticsearch Query)

query Examples

"device.hostname: *.lab"

title

Human-readable title for this scheduled job

title

title Type

string (Job Title)

title 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

title Examples

"Daily Backup Job"

Definitions group CrontabConfiguration

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/CrontabConfiguration"}
Property Type Required Nullable Defined by
dayOfMonth string Required cannot be null Root Workflow
dayOfWeek string Required cannot be null Root Workflow
hour string Required cannot be null Root Workflow
minute string Required cannot be null Root Workflow
month string Required cannot be null Root Workflow
second string Required cannot be null Root Workflow
timezone string Required cannot be null Root Workflow

dayOfMonth

Specifies the day of month (1-31) when the workflow should run. Supports standard cron syntax.

dayOfMonth

dayOfMonth Type

string (Day of Month)

dayOfWeek

Specifies the day of week (0-6 where 0=Sunday) when the workflow should run. Supports standard cron syntax.

dayOfWeek

dayOfWeek Type

string (Day of Week)

hour

Specifies the hours (0-23) when the workflow should run. Supports standard cron syntax.

hour

hour Type

string (Hours)

minute

Specifies the minutes (0-59) when the workflow should run. Supports standard cron syntax.

minute

minute Type

string (Minutes)

month

Specifies the month (1-12) when the workflow should run. Supports standard cron syntax.

month

month Type

string (Month)

month Examples

"*"

second

Specifies the seconds (0-59) when the workflow should run. Supports standard cron syntax including:

    • (any value)
  • , (value list separator)
    • (range of values)
  • / (step values)

second

second Type

string (Seconds)

timezone

Represents a timezone identifier in IANA Time Zone Database format

timezone

timezone Type

string (Timezone)

timezone Constraints

unknown format: the value of this string must follow the format: timezone

timezone Examples

"America/New_York"

"Europe/Berlin"

"Asia/Tokyo"

Definitions group ElasticQuery

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/ElasticQuery"}
Property Type Required Nullable Defined by

Definitions group EntityAcquireByElasticQuery

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/EntityAcquireByElasticQuery"}
Property Type Required Nullable Defined by
assertNotEmpty boolean Optional cannot be null Root Workflow
description string Optional cannot be null Root Workflow
entity string Required cannot be null Root Workflow
limit Multiple Optional cannot be null Root Workflow
query string Required cannot be null Root Workflow
type string Required cannot be null Root Workflow

assertNotEmpty

assertNotEmpty

  • is optional

  • Type: boolean

  • cannot be null

  • defined in: Root Workflow

assertNotEmpty Type

boolean

description

description

  • is optional

  • Type: string

  • cannot be null

  • defined in: Root Workflow

description Type

string

entity

Types of entities that workflows can operate on

entity

entity Type

string (Entity Type)

entity Constraints

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

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

limit

limit

  • is optional

  • Type: any of the following: number or string (Details)

  • cannot be null

  • defined in: Root Workflow

limit Type

any of the following: number or string (Details)

query

query

  • is required

  • Type: string

  • cannot be null

  • defined in: Root Workflow

query Type

string

type

type

  • is required

  • Type: string

  • cannot be null

  • defined in: Root Workflow

type Type

string

type Constraints

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

"elastic"

Definitions group EntityAcquireByExpansion

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/EntityAcquireByExpansion"}
Property Type Required Nullable Defined by
assertNotEmpty boolean Optional cannot be null Root Workflow
description string Optional cannot be null Root Workflow
entity string Required cannot be null Root Workflow
expandFromSeedEntity boolean Required cannot be null Root Workflow
type string Required cannot be null Root Workflow

assertNotEmpty

assertNotEmpty

  • is optional

  • Type: boolean

  • cannot be null

  • defined in: Root Workflow

assertNotEmpty Type

boolean

description

description

  • is optional

  • Type: string

  • cannot be null

  • defined in: Root Workflow

description Type

string

entity

Types of entities that workflows can operate on

entity

entity Type

string (Entity Type)

entity Constraints

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

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

expandFromSeedEntity

expandFromSeedEntity

  • is required

  • Type: boolean

  • cannot be null

  • defined in: Root Workflow

expandFromSeedEntity Type

boolean

type

type

  • is required

  • Type: string

  • cannot be null

  • defined in: Root Workflow

type Type

string

type Constraints

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

"expansion"

Definitions group EntityAcquireContext

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/EntityAcquireContext"}
Property Type Required Nullable Defined by
assertNotEmpty boolean Optional cannot be null Root Workflow
description string Optional cannot be null Root Workflow
entity string Required cannot be null Root Workflow
filter string Optional cannot be null Root Workflow
type string Required cannot be null Root Workflow

assertNotEmpty

assertNotEmpty

  • is optional

  • Type: boolean

  • cannot be null

  • defined in: Root Workflow

assertNotEmpty Type

boolean

description

description

  • is optional

  • Type: string

  • cannot be null

  • defined in: Root Workflow

description Type

string

entity

Types of entities that workflows can operate on

entity

entity Type

string (Entity Type)

entity Constraints

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

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

filter

filter

  • is optional

  • Type: string

  • cannot be null

  • defined in: Root Workflow

filter Type

string

type

type

  • is required

  • Type: string

  • cannot be null

  • defined in: Root Workflow

type Type

string

type Constraints

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

"context"

Definitions group EntityAcquireReference

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/EntityAcquireReference"}
Property Type Required Nullable Defined by
assertNotEmpty boolean Optional cannot be null Root Workflow
description string Optional cannot be null Root Workflow
entity string Required cannot be null Root Workflow
label string Required cannot be null Root Workflow
type string Required cannot be null Root Workflow

assertNotEmpty

assertNotEmpty

  • is optional

  • Type: boolean

  • cannot be null

  • defined in: Root Workflow

assertNotEmpty Type

boolean

description

description

  • is optional

  • Type: string

  • cannot be null

  • defined in: Root Workflow

description Type

string

entity

Types of entities that workflows can operate on

entity

entity Type

string (Entity Type)

entity Constraints

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

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

label

label

  • is required

  • Type: string

  • cannot be null

  • defined in: Root Workflow

label Type

string

type

type

  • is required

  • Type: string

  • cannot be null

  • defined in: Root Workflow

type Type

string

type Constraints

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

"reference"

Definitions group EntityAcquireType

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/EntityAcquireType"}
Property Type Required Nullable Defined by

Definitions group EntityType

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/EntityType"}
Property Type Required Nullable Defined by

Definitions group JmesCondition

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/JmesCondition"}
Property Type Required Nullable Defined by
description string Optional cannot be null Root Workflow
jmes Multiple Required cannot be null Root Workflow
type string Required cannot be null Root Workflow

description

description

  • is optional

  • Type: string

  • cannot be null

  • defined in: Root Workflow

description Type

string

jmes

jmes

  • is required

  • Type: any of the following: string or boolean (Details)

  • cannot be null

  • defined in: Root Workflow

jmes Type

any of the following: string or boolean (Details)

type

type

  • is required

  • Type: string

  • cannot be null

  • defined in: Root Workflow

type Type

string

type Constraints

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

"jmes"

Definitions group ParametrizedFunctionBlock

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/ParametrizedFunctionBlock"}
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
functionBlock string Required 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
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)

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"

functionBlock

Fully qualified function block identifier in format "package/name:version". Must match the pattern.

functionBlock

functionBlock Type

string (Function Block SemVer Identifier)

functionBlock Constraints

pattern: the string must match the following regular expression: 

^([^/:-]+)\/([^/:-]+):\d+(\.\d+)?(\.\d+)?$

try pattern

functionBlock Examples

"fb.neops.io/ping:1.0.0"

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"

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"

type

Type discriminator for workflow steps. Must be "functionBlock" for this type.

type

type Type

string (Type)

type Constraints

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

"functionBlock"

type Examples

"functionBlock"

Definitions group RepeatConfiguration

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/RepeatConfiguration"}
Property Type Required Nullable Defined by
condition object Optional cannot be null Root Workflow
delay number Optional can be null Root Workflow
repeats number Optional cannot be null Root Workflow

condition

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

condition

condition Type

object (Details)

delay

Delay in seconds between iterations

delay

delay Type

number (Iteration 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

100

repeats

Fixed number of times to repeat the operation

repeats

repeats Type

number (Repeats Count)

repeats Constraints

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

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

repeats Examples

5

Definitions group RetryConfiguration

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/RetryConfiguration"}
Property Type Required Nullable Defined by
condition object Optional cannot be null Root Workflow
delay number Optional can be null Root Workflow
maxRetries number Required cannot be null Root Workflow

condition

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

condition

condition Type

object (Details)

delay

Optional delay in seconds between retry attempts

delay

delay Type

number (Retry 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

100

maxRetries

Maximum number of retry attempts (1-100)

maxRetries

maxRetries Type

number (Max Retries)

maxRetries Constraints

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

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

maxRetries Examples

3

Definitions group Timezone

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/Timezone"}
Property Type Required Nullable Defined by

Definitions group WorkflowAsStep

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/WorkflowAsStep"}
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"

Definitions group WorkflowConfig

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/WorkflowConfig"}
Property Type Required Nullable Defined by
executionStrategy object Optional cannot be null Root Workflow

executionStrategy

Defines how a workflow should be executed

executionStrategy

executionStrategy Type

object (Workflow Execution Strategy)

Definitions group WorkflowExecutionStrategy

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/WorkflowExecutionStrategy"}
Property Type Required Nullable Defined by
parallel boolean Optional cannot be null Root Workflow

parallel

If true, jobs that can be executed in parallel will be run concurrently. This executes steps in parallel if they are not dependent on each other. That is, when running on devices, device 1 may be in step A and device 2 may be in step B (after completing step A), as they do not depend on each other.

parallel

parallel Type

boolean (Execute in job sequences in parallel when possible)

Definitions group WorkflowReference

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/WorkflowReference"}
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

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)

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"

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"

strategy

Execution strategy for referenced workflow

strategy

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

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

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"

Definitions group WorkflowStep

Reference this group by using

{"$ref":"docs.neops.io/schema/RootWorkflow#/definitions/WorkflowStep"}
Property Type Required Nullable Defined by
type Not specified Required cannot be null Root Workflow

type

type

  • is required

  • Type: unknown

  • cannot be null

  • defined in: Root Workflow

type Type

unknown

type Constraints

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

Value Explanation
"workflow"
"workflowReference"
"functionBlock"