Get cable details
- 28 Aug 2024
- 9 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get cable details
- Updated on 28 Aug 2024
- 9 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/cables/{id}
Operation is used to retrieve full details of given cable id. Available from product version 3.2.6.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integerRequired
Id of cable
Responses
200
Cable
object
automSecLengthCalc
boolean
Automatic secondary length calculation
batch
string
Cable batch
cableId
string
Cable ID
cableType
object (CableType)
Cable type
attenuation
number (float)
Attenuation (dB/km)
availabilityEnd
string (date)
Availability end
availabilityStart
string (date)
Availability start
colorCoding
object (CableTypeColorCoding)
Color coding
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[ "CABLE_COLORCODING" ]
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
colorConfig
object (CableTypeColorConfig)
codingType
string
Color config coding type
description
string
Description
maxNumberOfThreads
integer
Maximum number of threads
name
string
Name
cuCapacity
integer
Copper capacity
defInstallation
object (CableTypeDefInstallation)
Default installation
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[ "CABLE_TYPE" ]
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
diameter
number (float)
Diameter (mm)
fiThreads
integer
Fiber threads
id
integer
Primary key
list_url
string
Url to fetch all cable types
resistance
integer
Resistance
technology
object (CableTypeTechnology)
Cable type technology
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[ "CABLE_TECHNOLOGY" ]
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
type
string
Cable type
unitCost
number (float)
Unit cost
connectedCapacity
integer
Connected capacity. This field can not be used for filtering results in searches. Available from product version 3.2.12.
connections
Array of object (Connection)
List of cable's connection objects
object
An object representing a connection between cable and another object.
cableDirection
string
Describes which end the connection exists on. Either Beginning or End.
Valid values[ "B", "E" ]
manhole
object (MinifiedManhole)
Minified information of a telecom manhole object
id
integer
Manhole primary key
manholeId
string
Name of manhole
type
object (ManholeType)
Manhole 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[ "MANHOLE_TYPE" ]
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
premises
object (MinifiedPremises)
Minified information of a telecom premises object
id
integer
Premises primary key
name
string
Name of premises
prem_id
string
Premises identification
type
object (PremType)
Premises type
id
integer
Primary key
listUrl
string (url)
Url to fetch all objects
manufacturer
string
Premises manufacturer
productCode
string
Product code
type
object (PremTypeType)
Premises type 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[ "PREM_TYPE" ]
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
url
string (url)
Url to full information of premises object
splice
object (MinifiedSplice)
Minified information of a telecom splice object
id
integer
Splice primary key
spliceNumber
string
Splice number
type
object (SpliceType)
Splice 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[ "SPLICE_TYPE" ]
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
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
object (HeightAccuracy)
Height accuracy
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[ "H_ACCURACY" ]
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
historyDate
string (date-time)
Mapping date
id
integer
Primary key
importance
integer
Cable importance
installYear
integer
Install year
installationType
object (CableTypeDefInstallation)
Default installation
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[ "CABLE_TYPE" ]
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
layingState
object (CableLayingState)
Cable laying 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[ "CABLE_LAYING_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
length
number (float)
Cable length
location
string (ewkt)
Geographical location
locationAccuracy
object (CableLocationAccuracy)
Cable location accuracy
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[ "CABLE_LOC_ACCURACY" ]
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
mapper
string
Mapper
mappingMethod
object (MappingMethod)
Mapping method
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[ "MAPPING_METHOD" ]
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
measure
object (CableMeasure)
Cable or conduit measure
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[ "CABLE_MEASURE" ]
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
moveWithConduit
boolean
Is cable geometry altered to connected conduits. Available from 3.2.16 on demand.
owner
object (CableOwner)
Cable owner
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[ "CABLE_OWNER" ]
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
plan
string (url)
Url to fetch details of related plan.
rentPaid
boolean
Is rent paid
renter
object (CableOwner)
Cable owner
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[ "CABLE_OWNER" ]
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
role
object (CableRole)
Cable role
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[ "CABLE_ROLE" ]
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
safetyDistance
object (SafetyDistance)
Safety Distance
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[ "SAFETY_DISTANCE" ]
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
secondaryLength
number (float)
Secondary length
startReading
integer
Start reading
state
object (CableState)
Cable 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[ "CABLE_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
supercable
string (url)
Url to fetch details of supercable.
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?
