Create circuit fault location
- 28 Oct 2024
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Create circuit fault location
- Updated on 28 Oct 2024
- 3 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Post
/circuitFaultLocation/
NOTE: This API is provided by a separate service.
This API endpoint searches for certain alarm determined by alarmId. If the alarm is already present in KeyCom then it is updated with the values provided in the request. If it is not, it makes a trace for specified distance from certain circuit section (and possibly port id) and using either logical or physical reservations finds the component of network affected by fault. Then the fault is created in the specified location.
Available from product version 3.6.2.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Header parameters
Accept-Language
string
Two-letter language code to use for interface translation. Example: Accept-Language=en
Query parameters
srs
string
Coordinate system to transform location to.
Example: srs=epsg:4326
Body parameters
circuit fault to be traced and created
object
alarmId
string
id of the external object describing the fault, i.e. alarm
description
string
circuit fault description
direction
string
the direction to go through the reservations as of the reservation order to avoid ambiguous results
Valid values[ "asc", "desc" ]
distance
number (float) Required
optical distance for locating the fault
faultState
integer
id of circuit fault state, used for Alarm state (New, Updated or Cleared)
faultType
integer
id of circuit fault type, used for Severity (Break or Degradation)
loss
number (float)
Loss (dB) caused by fault
portId
integer
port (cross-connection point) to be traced
reservation
string
specifies if logical or physical reservations of the circuit section are used for locating the fault
Valid values[ "logical", "physical" ]
sectionId
integer Required
circuit section to be traced
Responses
201
created circuit fault and fault location
{
"alarmId": "123456",
"description": "test",
"distance": 30.0,
"faultState": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "CIRCUIT_LOG_STATE",
"id": 6770,
"logical_txt": "Ilmoitettu",
"num_value": null,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Ilmoitettu"
},
"faultType": {
"availability_end_ts": null,
"availability_start_ts": null,
"available": true,
"groupname": "CIRCUIT_LOG_ENTRY",
"id": 6690,
"logical_txt": "Rätisee",
"num_value": null,
"num_value2": null,
"num_value3": null,
"num_value4": null,
"txt": "Rätisee"
},
"id": 15650,
"location": "SRID=4326;POINT Z (60.54678877583297 26.17476424505218 -7.941480726003647e-05)",
"loss": 3.1,
"objectId": 152255,
"objectType": "threaddetail",
"routeEndReached": false,
"routeLocation": "SRID=4326;LINESTRING Z (60.54676895577271 26.17497882752768 -7.941573858261108e-05, 60.62600056457995 26.20147963427254 -7.953960448503494e-05, 60.54676871806093 26.17494091868807 -7.941387593746185e-05, 60.54676415016116 26.17478779664355 -7.941294461488724e-05, 60.54677229193739 26.17476404222064 -7.941573858261108e-05, 60.54678877583297 26.17476424505218 -7.941480726003647e-05)",
"sectionId": 561
}object
distance
number (float)
calculated distance from all objects along the route found (cross-connections, device internal connections, cable total lengths)
location
string (ewkt)
calculated location of the fault, taking into account possible loops and coils along the route
objectId
integer
id of object affected by fault
objectType
string
type of object affected by fault
Valid values[ "threaddetail", "crossconnectionpoint" ]
routeEndReached
boolean
is route end reached or route ended preliminary
routeLocation
string (ewkt)
route from start of trace to object affected by fault (including object affected by fault)
alarmId
string
id of the external object describing the fault, i.e. alarm
description
string
circuit fault description
faultState
object (CircuitFaultState)
Circuit fault state
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "CIRCUIT_LOG_STATE" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
faultType
object (CircuitFaultType)
Circuit fault type
availability_end_ts
string (date-time)
Ending date time for availability
availability_start_ts
string (date-time)
Beginning date time for availability
available
boolean
Is object deemed as available. Based on availability_start_ts and availability_end_ts values.
groupname
Group name of constant
Valid values[ "CIRCUIT_LOG_ENTRY" ]
id
integer
Unique id of constant
list_url
string (url)
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number (float)
Numeric value
num_value2
number (float)
Numeric value 2
num_value3
number (float)
Numeric value 3
num_value4
number (float)
Numeric value 4
txt
string
Human readable textual representation
id
integer
id of circuit fault in KeyCom
loss
number (float)
Loss (dB) caused by fault
400
There was an error in request. Usually field validation failed.
object
Fields which failed validation
property*
Array of string additionalProperties
List of validation errors for this fieldname
string
Validation error
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
Was this article helpful?
