Skip to content
jtWMS Docs

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

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

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
runId
required
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

OK

object
runId
required
string format: uuid
seq
required
integer format: int64
simTime
required
number format: double
status
required
string
Allowed values: Queued Provisioning Running Paused Completed Failed Cancelled
speed
required
object
mode
required
string
Allowed values: Paced AsFastAsPossible
factor
required
number format: double
nullable >= 0.1 <= 100
entities
required
Array<object>
object
id
required
string
kind
required
string
Allowed values: operator container cart
code
required
string
nullable
role
string
nullable
Allowed values: Picker BatchPicker Putter Packer Receiver PutawayOperator Loader
operatorState
string
nullable
Allowed values: Idle Travelling Picking Putting Packing Receiving PuttingAway Loading Inducting
containerType
string
nullable
Allowed values: Tote BatchTote Carton Pallet Unknown
containerState
string
nullable
Allowed values: Open Carried OnConveyor Arrived AtPutWall Packed Loaded Exception Stored
parentId
required
string
nullable
position
required
object
x
required
number format: double
y
required
number format: double
motion
required
object
path
required
Array<object>
>= 2 items
object
x
required
number format: double
y
required
number format: double
startSimTime
required
number format: double
durationSim
required
number format: double
atId
required
string
nullable
orderRef
string
nullable
cubbies
required
Array<object>
object
cubbyId
required
string
state
required
string
orderRef
required
string
nullable
loads
required
Array<object>
object
loadId
required
string
dockDoorId
required
string
trailerNumber
required
string
status
required
string
containerCount
required
integer format: int32
metrics
required
object
simTime
required
number format: double
queues
required
Array<object>
object
taskType
required
string
Allowed values: Pick BatchPick Put Pack Ship Receive Putaway Load
depth
required
integer format: int32
operatorsByState
required
Array<object>
object
state
required
string
Allowed values: Idle Travelling Picking Putting Packing Receiving PuttingAway Loading Inducting
count
required
integer format: int32
kpis
required
object
ordersReleased
required
integer format: int32
ordersShipped
required
integer format: int32
linesPicked
required
integer format: int32
unitsPicked
required
integer format: int64
containersInducted
required
integer format: int32
routingExceptions
required
integer format: int32
receipts
required
integer format: int32
putaways
required
integer format: int32
apiCalls
required
integer format: int64
apiErrors
required
integer format: int64

404

Section titled “404”

Not Found

object
type
string
nullable
title
string
nullable
status
integer format: int32
nullable
detail
string
nullable
instance
string
nullable