Get list of Cable types

28 Oct 2024
3 Minutes to read
Contributors

Print
Dark
Light
PDF

Get list of Cable types

Updated on 28 Oct 2024
3 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/cabletypes/

Operation is used to get a list of Cable types. Available from product version 3.2.6.

Cable types can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Query parameters

offset

integer

Offset to start returning results.

Minimum0

limit

integer

Limit number of results returned. Set to -1 to use maximum limit set in the environment. Default limit will be used if parameter is not specified. Special value -1 is available from product version 3.2.18.

Minimum1

__any of the object fields__

string

Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:

For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
For numerics: gt, lt, gte, lte, isnull
For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++ Supports exclusive queries by field value using a not-operator preceeding the field lookup: Examples: +++not__type__txt__istartswith=Tie+++ , +++not__id=1390+++

orderby

string

Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date

Responses

200

A result response object.

{
  "attenuation": null,
  "availabilityEnd": null,
  "availabilityStart": null,
  "colorCoding": null,
  "colorConfig": null,
  "cuCapacity": 1,
  "defInstallation": {
    "availability_end_ts": "2020-12-31",
    "availability_start_ts": "2020-01-01",
    "available": true,
    "groupname": "CABLE_TYPE",
    "id": 941,
    "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/CABLE_TYPE/",
    "logical_txt": "Maa",
    "num_value": 10.1,
    "num_value2": 20.2,
    "num_value3": 30.3,
    "num_value4": 40.4,
    "txt": "Buried"
  },
  "diameter": null,
  "fiThreads": 0,
  "id": 10,
  "resistance": null,
  "technology": {
    "availability_end_ts": "2020-12-31",
    "availability_start_ts": "2020-01-01",
    "available": true,
    "groupname": "CABLE_TECHNOLOGY",
    "id": 70,
    "list_url": "http://keycom.example.com/api/v2/txt_constants/groupname/CABLE_TECHNOLOGY/",
    "logical_txt": "KTV",
    "num_value": 10.1,
    "num_value2": 20.2,
    "num_value3": 30.3,
    "num_value4": 40.4,
    "txt": "CTV"
  },
  "type": "Tellu 3",
  "unitCost": null
}

Expand All

object

string (url)

Url to next page of Cable types. Null if No next page exist

string (url)

Url to previous page of Cable types. Null if No previous page exist

Results

Array of object (CableType)

List of fetched Cable types

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" ]

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" ]

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

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" ]

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

Total

integer

Total number of Cable types

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Get list of constants