Update device partially
- 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Update device partially
- Updated on 28 Oct 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Patch
/devices/{id}/
Operation is used to update specific fields in existing device. Available from product version 3.0.24.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of device to update
Body parameters
Device attributes and values to be updated
object
comments
string
Remarks
connectorCount
integer
Connector count
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
identification
string Required
Identification
interface
string
Interface
locationArea
string
Location area. Available from product version 3.6.
locationRack
string
Location rack. Available from product version 3.6.
locationRackRow
string
Location rack row. Available from product version 3.6.
locationSide
string
Location side. Available from product version 3.6.
locationSlot
string
Location slot. Available from product version 3.6.
locationSubSlot
string
Location sub slot. Available from product version 3.6.
locationSubrack
string
Location sub rack. Available from product version 3.6.
managementAddress
string
Management address
managementAddress2
string
Management address 2
orderNo
integer
Order number
owner
integer
Device owner
parent
integer
Parent terminal id
premise
integer Required
Telecom premises
renter
integer
Device renter
sourceSystem
integer
Source system id. Available from product version 3.4.
sourceSystemKey
integer
source system key. Available from product version 3.4.
startPin
integer
Start connector
type
integer Required
Terminal type
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
usageState
integer
Terminal state
Responses
200
Object was updated successfully
object
comments
string
Remarks
connectorCount
integer
Connector count
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
id
integer
Primary key
identification
string
Identification
interface
string
Interface
locationArea
string
Location area. Available from product version 3.6.
locationRack
string
Location rack. Available from product version 3.6.
locationRackRow
string
Location rack row. Available from product version 3.6.
locationSide
string
Location side. Available from product version 3.6.
locationSlot
string
Location slot. Available from product version 3.6.
locationSubSlot
string
Location sub slot. Available from product version 3.6.
locationSubrack
string
Location sub rack. Available from product version 3.6.
managementAddress
string
Management address
managementAddress2
string
Management address 2
orderNo
integer
Order number
owner
integer
Device owner
parent
integer
Parent terminal id
premise
integer
Telecom premises
renter
integer
Device renter
sourceSystem
integer
Source system id. Available from product version 3.4.
sourceSystemKey
integer
source system key. Available from product version 3.4.
startPin
integer
Start connector
type
integer
Terminal type
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
usageState
integer
Terminal state
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
404
Object was not found
{
"details": "Not found."
}object
details
string
Detailed description of error
Was this article helpful?
