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

GET

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

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

Authorizations

• Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

Responses

200

OK

object

id

required

string format: uuid

facilityId

required

string format: uuid

version

required

integer format: int32

publishedAt

required

string format: date-time

isActive

required

boolean

nodes

required

Array<object>

object

id

required

string format: uuid

code

required

string

name

required

string

nodeType

required

string

lengthMillimeters

required

number format: double

nullable

edges

required

Array<object>

object

sourceNodeCode

required

string

targetNodeCode

required

string

destinations

required

Array<object>

object

id

required

string format: uuid

code

required

string

type

required

string

Allowed values: PackStation PutWallInduction ShipSortLane Exception

nodeCode

required

string

putWallCode

required

string

nullable

inductionNodeCodes

required

Array<string>

decisionPoints

required

Array<object>

object

nodeCode

required

string

scannerCode

required

string

exitNodeCodes

required

Array<string>

recirculationExitNodeCode

required

string

nullable

exceptionDestinationCode

required

string

object

id

required

string format: uuid

facilityId

required

string format: uuid

version

required

integer format: int32

publishedAt

required

string format: date-time

isActive

required

boolean

nodes

required

Array<object>

object

id

required

string format: uuid

code

required

string

name

required

string

nodeType

required

string

lengthMillimeters

required

number format: double

nullable

edges

required

Array<object>

object

sourceNodeCode

required

string

targetNodeCode

required

string

destinations

required

Array<object>

object

id

required

string format: uuid

code

required

string

type

required

string

Allowed values: PackStation PutWallInduction ShipSortLane Exception

nodeCode

required

string

putWallCode

required

string

nullable

inductionNodeCodes

required

Array<string>

decisionPoints

required

Array<object>

object

nodeCode

required

string

scannerCode

required

string

exitNodeCodes

required

Array<string>

recirculationExitNodeCode

required

string

nullable

exceptionDestinationCode

required

string

Example

{
  "destinations": [
    {
      "type": "PackStation"
    }
  ]
}

object

id

required

string format: uuid

facilityId

required

string format: uuid

version

required

integer format: int32

publishedAt

required

string format: date-time

isActive

required

boolean

nodes

required

Array<object>

object

id

required

string format: uuid

code

required

string

name

required

string

nodeType

required

string

lengthMillimeters

required

number format: double

nullable

edges

required

Array<object>

object

sourceNodeCode

required

string

targetNodeCode

required

string

destinations

required

Array<object>

object

id

required

string format: uuid

code

required

string

type

required

string

Allowed values: PackStation PutWallInduction ShipSortLane Exception

nodeCode

required

string

putWallCode

required

string

nullable

inductionNodeCodes

required

Array<string>

decisionPoints

required

Array<object>

object

nodeCode

required

string

scannerCode

required

string

exitNodeCodes

required

Array<string>

recirculationExitNodeCode

required

string

nullable

exceptionDestinationCode

required

string

Example

{
  "destinations": [
    {
      "type": "PackStation"
    }
  ]
}

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