Update cable partially
- 28 Aug 2024
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Update cable partially
- Updated on 28 Aug 2024
- 2 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Patch
/cables/{id}
Operation is used to update specific fields in existing cable. Available from product version 3.2.6.
Note: When creating cable with length, measure ID is required.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of cable to update
Body parameters
Cable attributes and values to be updated
object
automSecLengthCalc
boolean
Automatic secondary length calculation
batch
string
Cable batch
cableId
string
Cable ID
cableType
integer Required
Cable type id
endReading
integer
End reading
falseCable
boolean
Is cable a false cable
heightAccuracy
integer
Height accuracy id
historyDate
string (date-time)
Mapping date
importance
integer
Cable importance
installYear
integer
Install year
installationType
integer Required
Cable installation type id
layingState
integer
Laying state id of the cable
length
number (float)
Cable length. Writeable from 3.2.20.
location
string (ewkt)
Geographical location
locationAccuracy
integer
Location accuracy id
mapper
string
Mapper
mappingMethod
integer
Mapping method id
measure
integer
Measure id
owner
integer
Cable owner id
plan
integer
Plan id
rentPaid
boolean
Is rent paid
renter
integer
Cable renter id
role
integer
Cable role id
safetyDistance
integer
Safety distance id. Available from product version 3.6.4.
secondaryLength
number (float)
Secondary length
startReading
integer
Start reading
state
integer Required
Cable state id
supercable
integer
supercable id
supercableOrderNo
integer
Specifies supercable order
surveyAmount
integer
Survey amount
telecomArea
integer
Telecom area id
Responses
200
Object was updated successfully
object
automSecLengthCalc
boolean
Automatic secondary length calculation
batch
string
Cable batch
cableId
string
Cable ID
cableType
integer
Cable type id
connectedCapacity
integer
Connected capacity. This field can not be used for filtering results in searches. Available from product version 3.2.12.
createdBy
string
Creator
createdTs
string (date-time)
Creation date time
endReading
integer
End reading
extraLength
number (float)
Extra length
falseCable
boolean
Is cable a false cable
freeCapacity
integer
Free capacity. This field can not be used for filtering results in searches. Available from product version 3.2.12.
heightAccuracy
integer
Height accuracy id
historyDate
string (date-time)
Mapping date
id
integer
Primary key
importance
integer
Cable importance
installYear
integer
Install year
installationType
integer
Cable installation type id
layingState
integer
Laying state id of the cable
length
number (float)
Cable length. Writeable from 3.2.20.
location
string (ewkt)
Geographical location
locationAccuracy
integer
Location accuracy id
mapper
string
Mapper
mappingMethod
integer
Mapping method id
measure
integer
Measure id
owner
integer
Cable owner id
plan
integer
Plan id
rentPaid
boolean
Is rent paid
renter
integer
Cable renter id
role
integer
Cable role id
safetyDistance
integer
Safety distance id. Available from product version 3.6.4.
secondaryLength
number (float)
Secondary length
startReading
integer
Start reading
state
integer
Cable state id
supercable
integer
supercable id
supercableOrderNo
integer
Specifies supercable order
surveyAmount
integer
Survey amount
telecomArea
integer
Telecom area id
totalCapacity
integer
Total capacity
totalLength
number (float)
Total length
updatedBy
string
Last updater
updatedTs
string (date-time)
Last update date time
usedCapacity
integer
Used capacity. This field can not be used for filtering results in searches. Available from product version 3.2.12.
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?
