Get cable type details
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Get cable type details

  • Dark
    Light
  • PDF

Article summary

Get
/cabletypes/{id}

Operation is used to retrieve full details of given cable type 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 type

Responses
200

Cable type

Expand All
object

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

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?