Get list of electrical cable types
  • 29 Aug 2023
  • 7 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Get list of electrical cable types

  • Dark
    Light
  • PDF

Article summary

Get
/el_cabletypes/

Operation is used to get a list of electrical cable types. Available from product version 3.2.2. List 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.

Min length0
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.

Min length1
__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.

{
  "Next": "http://keylight.example.com/api/v2/el_cabletypes/?limit=10&offset=10",
  "Previous": null,
  "Results": [
    {
      "R_L": null,
      "R_N": null,
      "X_L": null,
      "X_LN": null,
      "X_N": null,
      "cable_technology": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "EL_CABLE_TECHNOLOGY",
        "id": 298930,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/EL_CABLE_TECHNOLOGY/",
        "logical_txt": "Liikennevalot",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Liikennevalot"
      },
      "id": 930,
      "installation_type": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CABLE_TYPE",
        "id": 941,
        "list_url": "http://keylight.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": "Maa"
      },
      "specification": "2*2,5+2,5",
      "tech_name": "",
      "temperature": null,
      "type_name": "MCMK2x2,5+2,5",
      "voltage": null
    },
    {
      "R_L": null,
      "R_N": null,
      "X_L": null,
      "X_LN": null,
      "X_N": null,
      "cable_technology": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "EL_CABLE_TECHNOLOGY",
        "id": 298910,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/EL_CABLE_TECHNOLOGY/",
        "logical_txt": "Katuvalo",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Katuvalo"
      },
      "id": 940,
      "installation_type": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CABLE_TYPE",
        "id": 941,
        "list_url": "http://keylight.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": "Maa"
      },
      "specification": "2*2,5+2,5",
      "tech_name": "",
      "temperature": null,
      "type_name": "MCMK2x2,5+2,5",
      "voltage": null
    },
    {
      "R_L": null,
      "R_N": null,
      "X_L": null,
      "X_LN": null,
      "X_N": null,
      "cable_technology": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "EL_CABLE_TECHNOLOGY",
        "id": 298930,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/EL_CABLE_TECHNOLOGY/",
        "logical_txt": "Liikennevalot",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Liikennevalot"
      },
      "id": 950,
      "installation_type": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CABLE_TYPE",
        "id": 941,
        "list_url": "http://keylight.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": "Maa"
      },
      "specification": "3*2,5+2,5",
      "tech_name": "",
      "temperature": null,
      "type_name": "MCMK3x2,5+2,5",
      "voltage": null
    },
    {
      "R_L": 0.8,
      "R_N": 0.7,
      "X_L": 0.1,
      "X_LN": 0.07,
      "X_N": 0.04,
      "cable_technology": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "EL_CABLE_TECHNOLOGY",
        "id": 298930,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/EL_CABLE_TECHNOLOGY/",
        "logical_txt": "Liikennevalot",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Liikennevalot"
      },
      "id": 960,
      "installation_type": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CABLE_TYPE",
        "id": 941,
        "list_url": "http://keylight.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": "Maa"
      },
      "specification": "4*1,5+1,5",
      "tech_name": "",
      "temperature": 20,
      "type_name": "MCMK4x1,5+1,5",
      "voltage": null
    },
    {
      "R_L": null,
      "R_N": null,
      "X_L": null,
      "X_LN": null,
      "X_N": null,
      "cable_technology": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "EL_CABLE_TECHNOLOGY",
        "id": 298950,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/EL_CABLE_TECHNOLOGY/",
        "logical_txt": "Muu järjestelmä",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Muu järjestelmä"
      },
      "id": 970,
      "installation_type": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CABLE_TYPE",
        "id": 941,
        "list_url": "http://keylight.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": "Maa"
      },
      "specification": "MCMO 19*1,5",
      "tech_name": "",
      "temperature": null,
      "type_name": "MCMO 19x1,5",
      "voltage": null
    },
    {
      "R_L": null,
      "R_N": null,
      "X_L": null,
      "X_LN": null,
      "X_N": null,
      "cable_technology": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "EL_CABLE_TECHNOLOGY",
        "id": 298930,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/EL_CABLE_TECHNOLOGY/",
        "logical_txt": "Liikennevalot",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Liikennevalot"
      },
      "id": 980,
      "installation_type": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CABLE_TYPE",
        "id": 941,
        "list_url": "http://keylight.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": "Maa"
      },
      "specification": "19*1,5",
      "tech_name": "",
      "temperature": null,
      "type_name": "MCMO19",
      "voltage": null
    },
    {
      "R_L": 0.8,
      "R_N": 0.7,
      "X_L": 0.1,
      "X_LN": 0.07,
      "X_N": 0.04,
      "cable_technology": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "EL_CABLE_TECHNOLOGY",
        "id": 298950,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/EL_CABLE_TECHNOLOGY/",
        "logical_txt": "Muu järjestelmä",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Muu järjestelmä"
      },
      "id": 990,
      "installation_type": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CABLE_TYPE",
        "id": 941,
        "list_url": "http://keylight.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": "Maa"
      },
      "specification": "MMVDMA 20*0,8+0,8",
      "tech_name": "",
      "temperature": 20,
      "type_name": "MMVDMA 20x0,8+0,8",
      "voltage": null
    },
    {
      "R_L": null,
      "R_N": null,
      "X_L": null,
      "X_LN": null,
      "X_N": null,
      "cable_technology": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "EL_CABLE_TECHNOLOGY",
        "id": 298910,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/EL_CABLE_TECHNOLOGY/",
        "logical_txt": "Katuvalo",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Katuvalo"
      },
      "id": 1000,
      "installation_type": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CABLE_TYPE",
        "id": 941,
        "list_url": "http://keylight.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": "Maa"
      },
      "specification": "PLKVJ 2x6",
      "tech_name": "",
      "temperature": null,
      "type_name": "PLKVJ 2x6",
      "voltage": null
    },
    {
      "R_L": null,
      "R_N": null,
      "X_L": null,
      "X_LN": null,
      "X_N": null,
      "cable_technology": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "EL_CABLE_TECHNOLOGY",
        "id": 298910,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/EL_CABLE_TECHNOLOGY/",
        "logical_txt": "Katuvalo",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Katuvalo"
      },
      "id": 1010,
      "installation_type": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CABLE_TYPE",
        "id": 941,
        "list_url": "http://keylight.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": "Maa"
      },
      "specification": "PLKVJ 3x16+10",
      "tech_name": "",
      "temperature": null,
      "type_name": "PLKVJ 3x16+10",
      "voltage": null
    },
    {
      "R_L": null,
      "R_N": null,
      "X_L": null,
      "X_LN": null,
      "X_N": null,
      "cable_technology": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "EL_CABLE_TECHNOLOGY",
        "id": 298910,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/EL_CABLE_TECHNOLOGY/",
        "logical_txt": "Katuvalo",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Katuvalo"
      },
      "id": 1020,
      "installation_type": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "CABLE_TYPE",
        "id": 941,
        "list_url": "http://keylight.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": "Maa"
      },
      "specification": "PLKVJ 3x25+16",
      "tech_name": "",
      "temperature": null,
      "type_name": "PLKVJ 3x25+16",
      "voltage": null
    }
  ],
  "Total": 57
}
Expand All
object
Next
string

Url to next page of electric cable types. Null if No next page exist

Prev
string

Url to previous page of electric cable types. Null if No previous page exist

Results
Array of object (ElCableType)

List of fetched electric cable types

object

Electrical cable type

R_L
number

Resistance L [ohm/km]

R_N
number

Resistance N [ohm/km]

X_L
number

Reactance L [ohm/km]

X_LN
number

Reactance LN [ohm/km]

X_N
number

Reactance N [ohm/km]

cable_technology
object

Electrical cable technology

availability_end_ts
string

Ending date time for availability

availability_start_ts
string

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["EL_CABLE_TECHNOLOGY"]
id
integer

Unique id of constant

list_url
string

Url to fetch all contants from this group

logical_txt
string

Logical textual value

num_value
number

Numeric value

num_value2
number

Numeric value 2

num_value3
number

Numeric value 3

num_value4
number

Numeric value 4

txt
string

Human readable textual representation

conductor_material
object

Electrical cable default installation type

availability_end_ts
string

Ending date time for availability

availability_start_ts
string

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 to fetch all contants from this group

logical_txt
string

Logical textual value

num_value
number

Numeric value

num_value2
number

Numeric value 2

num_value3
number

Numeric value 3

num_value4
number

Numeric value 4

txt
string

Human readable textual representation

id
integer

Primary key

installation_type
object

Electrical cable default installation type

availability_end_ts
string

Ending date time for availability

availability_start_ts
string

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 to fetch all contants from this group

logical_txt
string

Logical textual value

num_value
number

Numeric value

num_value2
number

Numeric value 2

num_value3
number

Numeric value 3

num_value4
number

Numeric value 4

txt
string

Human readable textual representation

list_url
string

Url to fetch all cable types

specification
string

cable type specification

tech_name
string

cable tech name

temperature
number

Values measurement temperature, Celcius Degrees

type_name
string

cable type name

voltage
number

cable type voltage, V

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?