/api/v1/snapshot
GET
/api/v1/snapshot
const url = 'https://example.com/api/v1/snapshot';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://example.com/api/v1/snapshot \ --header 'Authorization: Bearer <token>'Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”OK
object
formatVersion
required
string
exportedAt
required
string format: date-time
facilities
required
Array<object>
object
formatVersion
required
string
exportedAt
required
string format: date-time
facilityId
required
string format: uuid
storageTree
required
Array<object>
object
id
required
string format: uuid
facilityId
required
string format: uuid
parentId
required
string format: uuid
nodeType
required
string
code
required
string
name
required
string
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
children
required
Array
locationCode
required
string
locationId
string format: uuid
locationAttributes
object
maxWeightKg
required
number format: double
maxVolumeLiters
required
number format: double
maxUnits
required
integer format: int32
storageType
required
string
temperatureClass
required
string
purpose
required
string
equipmentGraph
required
object
nodes
required
Array<object>
object
id
required
string format: uuid
facilityId
required
string format: uuid
nodeType
required
string
code
required
string
name
required
string
plcAddress
required
string
extendedAttributes
required
object
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
conveyorConfig
required
object
speedMetersPerSecond
number format: double
direction
string
widthMillimeters
number format: double
lengthMillimeters
number format: double
divertConfig
required
object
divertAngleDegrees
number format: double
numberOfOutputs
integer format: int32
divertStrategy
string
scannerConfig
required
object
scannerType
string
readRatePerMinute
integer format: int32
supportsMultiSide
boolean
inductionConfig
required
object
inductionRatePerHour
integer format: int32
inductionMethod
string
gtpConfig
required
object
gtpSystemType
string
podCapacity
integer format: int32
pickWindowSlots
integer format: int32
edges
required
Array<object>
object
id
required
string format: uuid
facilityId
required
string format: uuid
sourceEquipmentNodeId
required
string format: uuid
targetEquipmentNodeId
required
string format: uuid
label
required
string
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
zoneProfiles
required
Array<object>
object
id
required
string format: uuid
name
required
string
description
required
string
isActive
required
boolean
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
zones
required
Array<object>
object
id
required
string format: uuid
name
required
string
code
required
string
zoneType
required
string
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
locations
required
Array<object>
object
locationId
required
string format: uuid
code
required
string
object
formatVersion
required
string
exportedAt
required
string format: date-time
facilities
required
Array<object>
object
formatVersion
required
string
exportedAt
required
string format: date-time
facilityId
required
string format: uuid
storageTree
required
Array<object>
object
id
required
string format: uuid
facilityId
required
string format: uuid
parentId
required
string format: uuid
nodeType
required
string
code
required
string
name
required
string
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
children
required
Array
locationCode
required
string
locationId
string format: uuid
locationAttributes
object
maxWeightKg
required
number format: double
maxVolumeLiters
required
number format: double
maxUnits
required
integer format: int32
storageType
required
string
temperatureClass
required
string
purpose
required
string
equipmentGraph
required
object
nodes
required
Array<object>
object
id
required
string format: uuid
facilityId
required
string format: uuid
nodeType
required
string
code
required
string
name
required
string
plcAddress
required
string
extendedAttributes
required
object
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
conveyorConfig
required
object
speedMetersPerSecond
number format: double
direction
string
widthMillimeters
number format: double
lengthMillimeters
number format: double
divertConfig
required
object
divertAngleDegrees
number format: double
numberOfOutputs
integer format: int32
divertStrategy
string
scannerConfig
required
object
scannerType
string
readRatePerMinute
integer format: int32
supportsMultiSide
boolean
inductionConfig
required
object
inductionRatePerHour
integer format: int32
inductionMethod
string
gtpConfig
required
object
gtpSystemType
string
podCapacity
integer format: int32
pickWindowSlots
integer format: int32
edges
required
Array<object>
object
id
required
string format: uuid
facilityId
required
string format: uuid
sourceEquipmentNodeId
required
string format: uuid
targetEquipmentNodeId
required
string format: uuid
label
required
string
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
zoneProfiles
required
Array<object>
object
id
required
string format: uuid
name
required
string
description
required
string
isActive
required
boolean
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
zones
required
Array<object>
object
id
required
string format: uuid
name
required
string
code
required
string
zoneType
required
string
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
locations
required
Array<object>
object
locationId
required
string format: uuid
code
required
string
Example
{ "facilities": [ { "storageTree": [ { "locationId": null, "locationAttributes": null } ] } ]}object
formatVersion
required
string
exportedAt
required
string format: date-time
facilities
required
Array<object>
object
formatVersion
required
string
exportedAt
required
string format: date-time
facilityId
required
string format: uuid
storageTree
required
Array<object>
object
id
required
string format: uuid
facilityId
required
string format: uuid
parentId
required
string format: uuid
nodeType
required
string
code
required
string
name
required
string
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
children
required
Array
locationCode
required
string
locationId
string format: uuid
locationAttributes
object
maxWeightKg
required
number format: double
maxVolumeLiters
required
number format: double
maxUnits
required
integer format: int32
storageType
required
string
temperatureClass
required
string
purpose
required
string
equipmentGraph
required
object
nodes
required
Array<object>
object
id
required
string format: uuid
facilityId
required
string format: uuid
nodeType
required
string
code
required
string
name
required
string
plcAddress
required
string
extendedAttributes
required
object
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
conveyorConfig
required
object
speedMetersPerSecond
number format: double
direction
string
widthMillimeters
number format: double
lengthMillimeters
number format: double
divertConfig
required
object
divertAngleDegrees
number format: double
numberOfOutputs
integer format: int32
divertStrategy
string
scannerConfig
required
object
scannerType
string
readRatePerMinute
integer format: int32
supportsMultiSide
boolean
inductionConfig
required
object
inductionRatePerHour
integer format: int32
inductionMethod
string
gtpConfig
required
object
gtpSystemType
string
podCapacity
integer format: int32
pickWindowSlots
integer format: int32
edges
required
Array<object>
object
id
required
string format: uuid
facilityId
required
string format: uuid
sourceEquipmentNodeId
required
string format: uuid
targetEquipmentNodeId
required
string format: uuid
label
required
string
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
zoneProfiles
required
Array<object>
object
id
required
string format: uuid
name
required
string
description
required
string
isActive
required
boolean
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
zones
required
Array<object>
object
id
required
string format: uuid
name
required
string
code
required
string
zoneType
required
string
status
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
locations
required
Array<object>
object
locationId
required
string format: uuid
code
required
string
Example
{ "facilities": [ { "storageTree": [ { "locationId": null, "locationAttributes": null } ] } ]}