Update circuit fault data partially
- 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Update circuit fault data 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
/circuit-faults/{id}/
Operation is used to update specific fields in existing circuit fault. Available from product version 3.6.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of circuit fault to update
Body parameters
Circuit fault attributes and values to be updated
object
circuit
integer Required
Circuit related to the fault
description
string
circuit fault detail description in text
distance
number (float)
distance to the fault location
location
string (ewkt)
Geographical location for circuit fault
logState
integer
Circuit fault state
logType
integer
Circuit fault type
loss
number (float)
circuit fault loss
routeLocation
string (ewkt)
Geographical location for route
sourceSystem
integer
Source system id
sourceSystemKey
integer
External source key
Responses
200
Object was updated successfully
object
circuit
integer
Circuit related to the fault
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
description
string
circuit fault detail description in text
distance
number (float)
distance to the fault location
id
integer
Primary key
location
string (ewkt)
Geographical location for circuit fault
logState
integer
Circuit fault state
logType
integer
Circuit fault type
loss
number (float)
circuit fault loss
routeLocation
string (ewkt)
Geographical location for route
sourceSystem
integer
Source system id
sourceSystemKey
integer
External source key
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?
