Skip to content
jtWMS Docs

/api/v1/facilities/{facilityId}/equipment-nodes/{id} (PUT)

PUT
/api/v1/facilities/{facilityId}/equipment-nodes/{id}
curl --request PUT \
  --url https://example.com/api/v1/facilities/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/equipment-nodes/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/yaml' \
  --data '{ "code": "example", "name": "example", "nodeType": "Conveyor", "plcAddress": "example", "extendedAttributes": {}, "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 } }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
facilityId
required
string format: uuid
id
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
object
code
required
string
name
required
string
nodeType
required
string
Allowed values: Conveyor Divert Scanner Induction Transfer Merge Takeaway Gtp
plcAddress
required
string
nullable
extendedAttributes
required
object
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

Responses

Section titled “Responses”

200

Section titled “200”

OK

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

400

Section titled “400”

Bad Request

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

404

Section titled “404”

Not Found

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

409

Section titled “409”

Conflict

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