Create new circuit fault data
- 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Create new circuit fault data
- 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
Post
/circuit-faults/
Operation is used to create new circuit fault data. Available from product version 3.6.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Body parameters
circuit fault to be created
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
201
created circuit fault data
{
"circuit": 56376,
"createdBy": "keycom.user@keypro.fi",
"createdTs": "2013-05-13T04:02:59Z",
"description": "test",
"distance": 5.555,
"id": 410,
"location": null,
"logState": 6770,
"logType": 6690,
"loss": 3.6,
"routeLocation": null,
"sourceSystem": 260471,
"sourceSystemKey": 555,
"updatedBy": "keycom.user@keypro.fi",
"updatedTs": "2022-08-03T06:32:21Z"
}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
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?
