/api/v1/simulator/runs/{runId}/layout

GET

/api/v1/simulator/runs/{runId}/layout

curl --request GET \
  --url https://example.com/api/v1/simulator/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/layout \
  --header 'Authorization: Bearer <token>'

Authorizations

• Bearer

Parameters

Path Parameters

runId

required

string format: uuid

Responses

200

OK

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

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

{
  "entities": [
    {
      "kind": "area"
    }
  ]
}

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

{
  "entities": [
    {
      "kind": "area"
    }
  ]
}

404

Not Found

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

409

Conflict

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