/api/v1/simulator/scenarios/validate

POST

/api/v1/simulator/scenarios/validate

curl --request POST \
  --url https://example.com/api/v1/simulator/scenarios/validate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "format": "Yaml", "definition": "example" }'

Authorizations

• Bearer

Request Body^required

object

format

required

string

Allowed values: Yaml Json

definition

required

string

object

format

required

string

Allowed values: Yaml Json

definition

required

string

object

format

required

string

Allowed values: Yaml Json

definition

required

string

Responses

200

OK

object

valid

required

boolean

errors

required

Array<object>

object

path

required

string

code

required

string

message

required

string

line

required

integer format: int32

nullable

column

required

integer format: int32

nullable

warnings

required

Array<object>

object

path

required

string

code

required

string

message

required

string

line

required

integer format: int32

nullable

column

required

integer format: int32

nullable

scenarioName

required

string

nullable

durationSeconds

required

number format: double

nullable

requiredFeatures

required

Array<string>

requiredPermissions

required

Array<string>

estimatedApiCalls

required

integer format: int64

nullable

layout

required

object

width

required

number format: double

height

required

number format: double

entities

required

Array<object>

object

id

required

string

kind

required

string

Allowed values: area aisle location staging receivingDock packStation putWall cubby dockDoor conveyor induction scanner divert merge transfer

code

required

string

nullable

name

required

string

nullable

parentId

required

string

nullable

rect

required

object

x

required

number format: double

y

required

number format: double

width

required

number format: double

height

required

number format: double

polyline

required

Array<object>

nullable

object

x

required

number format: double

y

required

number format: double

position

required

object

x

required

number format: double

y

required

number format: double

speedMetersPerSecond

number format: double

nullable

rows

integer format: int32

nullable

columns

integer format: int32

nullable

row

integer format: int32

nullable

column

integer format: int32

nullable

destinationType

string

nullable

laneIds

Array<string>

nullable

connections

required

Array<object>

object

fromId

required

string

toId

required

string

object

valid

required

boolean

errors

required

Array<object>

object

path

required

string

code

required

string

message

required

string

line

required

integer format: int32

nullable

column

required

integer format: int32

nullable

warnings

required

Array<object>

object

path

required

string

code

required

string

message

required

string

line

required

integer format: int32

nullable

column

required

integer format: int32

nullable

scenarioName

required

string

nullable

durationSeconds

required

number format: double

nullable

requiredFeatures

required

Array<string>

requiredPermissions

required

Array<string>

estimatedApiCalls

required

integer format: int64

nullable

layout

required

object

width

required

number format: double

height

required

number format: double

entities

required

Array<object>

object

id

required

string

kind

required

string

Allowed values: area aisle location staging receivingDock packStation putWall cubby dockDoor conveyor induction scanner divert merge transfer

code

required

string

nullable

name

required

string

nullable

parentId

required

string

nullable

rect

required

object

x

required

number format: double

y

required

number format: double

width

required

number format: double

height

required

number format: double

polyline

required

Array<object>

nullable

object

x

required

number format: double

y

required

number format: double

position

required

object

x

required

number format: double

y

required

number format: double

speedMetersPerSecond

number format: double

nullable

rows

integer format: int32

nullable

columns

integer format: int32

nullable

row

integer format: int32

nullable

column

integer format: int32

nullable

destinationType

string

nullable

laneIds

Array<string>

nullable

connections

required

Array<object>

object

fromId

required

string

toId

required

string

Example

{
  "errors": [
    {
      "line": null,
      "column": null
    }
  ],
  "layout": {
    "entities": [
      {
        "kind": "area"
      }
    ]
  }
}

object

valid

required

boolean

errors

required

Array<object>

object

path

required

string

code

required

string

message

required

string

line

required

integer format: int32

nullable

column

required

integer format: int32

nullable

warnings

required

Array<object>

object

path

required

string

code

required

string

message

required

string

line

required

integer format: int32

nullable

column

required

integer format: int32

nullable

scenarioName

required

string

nullable

durationSeconds

required

number format: double

nullable

requiredFeatures

required

Array<string>

requiredPermissions

required

Array<string>

estimatedApiCalls

required

integer format: int64

nullable

layout

required

object

width

required

number format: double

height

required

number format: double

entities

required

Array<object>

object

id

required

string

kind

required

string

Allowed values: area aisle location staging receivingDock packStation putWall cubby dockDoor conveyor induction scanner divert merge transfer

code

required

string

nullable

name

required

string

nullable

parentId

required

string

nullable

rect

required

object

x

required

number format: double

y

required

number format: double

width

required

number format: double

height

required

number format: double

polyline

required

Array<object>

nullable

object

x

required

number format: double

y

required

number format: double

position

required

object

x

required

number format: double

y

required

number format: double

speedMetersPerSecond

number format: double

nullable

rows

integer format: int32

nullable

columns

integer format: int32

nullable

row

integer format: int32

nullable

column

integer format: int32

nullable

destinationType

string

nullable

laneIds

Array<string>

nullable

connections

required

Array<object>

object

fromId

required

string

toId

required

string

Example

{
  "errors": [
    {
      "line": null,
      "column": null
    }
  ],
  "layout": {
    "entities": [
      {
        "kind": "area"
      }
    ]
  }
}

400

Bad Request

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

string

nullable

title

string

nullable

status

integer format: int32

nullable

detail

string

nullable

instance

string

nullable

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}