/api/v1/facilities/{facilityId}/topology/export

GET

/api/v1/facilities/{facilityId}/topology/export

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

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

Query Parameters

format

string

Responses

200

OK

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

nullable

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

nullable

locationId

string format: uuid

nullable

locationAttributes

object

maxWeightKg

required

number format: double

nullable

maxVolumeLiters

required

number format: double

nullable

maxUnits

required

integer format: int32

nullable

storageType

required

string

nullable

temperatureClass

required

string

nullable

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

nullable

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

nullable

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

nullable

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

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

nullable

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

nullable

locationId

string format: uuid

nullable

locationAttributes

object

maxWeightKg

required

number format: double

nullable

maxVolumeLiters

required

number format: double

nullable

maxUnits

required

integer format: int32

nullable

storageType

required

string

nullable

temperatureClass

required

string

nullable

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

nullable

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

nullable

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

nullable

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

{
  "storageTree": [
    {
      "locationId": null,
      "locationAttributes": null
    }
  ]
}

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

nullable

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

nullable

locationId

string format: uuid

nullable

locationAttributes

object

maxWeightKg

required

number format: double

nullable

maxVolumeLiters

required

number format: double

nullable

maxUnits

required

integer format: int32

nullable

storageType

required

string

nullable

temperatureClass

required

string

nullable

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

nullable

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

nullable

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

nullable

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

{
  "storageTree": [
    {
      "locationId": null,
      "locationAttributes": null
    }
  ]
}

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

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