Update circuit partially
- 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Update circuit partially
- Updated on 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Patch
/circuits/{id}/
Operation is used to update specific fields in existing circuit. Available from product version 3.2.6.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of circuit to update
Body parameters
Circuit attributes and values to be updated
object
areaCode
string
Circuit area code
comments
string
Circuit comments. Available from product version 3.2.8.
contractLength
integer
Circuit contract length
contractNumber
string
Circuit contract number
customer
integer
Circuit customer id
directLength
number (float)
Circuit direct length
identifier
string
Circuit identifier
identifierAlt
string
Circuit alternative identifier
importance
integer
Circuit importance id
installationAddresses
Array of string
Circuit installations addresses
string (url)
length
number (float)
Circuit length
orderNumber
string
Circuit order number
organisation
integer
Circuit organisation id
redundancy
integer
Circuit redundancy id
sections
Array of string
Circuit sections
string (url)
Responses
200
Object was updated successfully
object
areaCode
string
Circuit area code
comments
string
Circuit comments. Available from product version 3.2.8.
contractLength
integer
Circuit contract length
contractNumber
string
Circuit contract number
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
customer
integer
Circuit customer id
directLength
number (float)
Circuit direct length
id
integer
Primary key
identifier
string
Circuit identifier
identifierAlt
string
Circuit alternative identifier
importance
integer
Circuit importance id
installationAddresses
Array of string
Circuit installations addresses
string (url)
length
number (float)
Circuit length
orderNumber
string
Circuit order number
organisation
integer
Circuit organisation id
redundancy
integer
Circuit redundancy id
sections
Array of string
Circuit sections
string (url)
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
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?
