/api/v1/facilities/{facilityId}/equipment-nodes/graph

GET

const url = 'https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/equipment-nodes/graph';
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/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/equipment-nodes/graph \
  --header 'Authorization: Bearer <token>'

Authorizations

Bearer

Parameters

Path Parameters

facilityId

required

string format: uuid

Responses

200

object

nodes

required

Array<object>

object

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

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

object

nodes

required

Array<object>

object

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

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

Example ^generated

{
  "nodes": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "facilityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "nodeType": "example",
      "code": "example",
      "name": "example",
      "plcAddress": "example",
      "extendedAttributes": {},
      "status": "example",
      "createdAt": "2026-04-15T12:00:00Z",
      "updatedAt": "2026-04-15T12:00:00Z",
      "conveyorConfig": {
        "speedMetersPerSecond": 1,
        "direction": "example",
        "widthMillimeters": 1,
        "lengthMillimeters": 1
      },
      "divertConfig": {
        "divertAngleDegrees": 1,
        "numberOfOutputs": 1,
        "divertStrategy": "example"
      },
      "scannerConfig": {
        "scannerType": "example",
        "readRatePerMinute": 1,
        "supportsMultiSide": true
      },
      "inductionConfig": {
        "inductionRatePerHour": 1,
        "inductionMethod": "example"
      },
      "gtpConfig": {
        "gtpSystemType": "example",
        "podCapacity": 1,
        "pickWindowSlots": 1
      }
    }
  ],
  "edges": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "facilityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "sourceEquipmentNodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "targetEquipmentNodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "label": "example",
      "status": "example",
      "createdAt": "2026-04-15T12:00:00Z",
      "updatedAt": "2026-04-15T12:00:00Z"
    }
  ]
}

object

nodes

required

Array<object>

object

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

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

Example ^generated

{
  "nodes": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "facilityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "nodeType": "example",
      "code": "example",
      "name": "example",
      "plcAddress": "example",
      "extendedAttributes": {},
      "status": "example",
      "createdAt": "2026-04-15T12:00:00Z",
      "updatedAt": "2026-04-15T12:00:00Z",
      "conveyorConfig": {
        "speedMetersPerSecond": 1,
        "direction": "example",
        "widthMillimeters": 1,
        "lengthMillimeters": 1
      },
      "divertConfig": {
        "divertAngleDegrees": 1,
        "numberOfOutputs": 1,
        "divertStrategy": "example"
      },
      "scannerConfig": {
        "scannerType": "example",
        "readRatePerMinute": 1,
        "supportsMultiSide": true
      },
      "inductionConfig": {
        "inductionRatePerHour": 1,
        "inductionMethod": "example"
      },
      "gtpConfig": {
        "gtpSystemType": "example",
        "podCapacity": 1,
        "pickWindowSlots": 1
      }
    }
  ],
  "edges": [
    {
      "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "facilityId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "sourceEquipmentNodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "targetEquipmentNodeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
      "label": "example",
      "status": "example",
      "createdAt": "2026-04-15T12:00:00Z",
      "updatedAt": "2026-04-15T12:00:00Z"
    }
  ]
}

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

/api/v1/facilities/{facilityId}/equipment-nodes/graph

Authorizations

Parameters

Path Parameters

Responses

200

Example generated

Example generated

404

Example generated

Example generated

Example ^generated

Example ^generated

Example ^generated

Example ^generated