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

Get list of electrical duct types

  • Dark
    Light
  • PDF

Article summary

Get
/el_ducttypes/

Operation is used to get a list of electrical duct 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": null,
  "Previous": null,
  "Results": [
    {
      "availability_end": null,
      "availability_start": null,
      "colour": "Harmaa",
      "cross_section_cell": "",
      "form": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 90,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Tavallinen",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Tavallinen"
      },
      "id": 1,
      "inner_diameter": null,
      "material": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7201,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Muovi",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Muovi"
      },
      "n_subducts": null,
      "outer_diameter": 50,
      "subduct_type": "",
      "type": "M50",
      "unit_cost": null
    },
    {
      "availability_end": null,
      "availability_start": null,
      "colour": "Harmaa",
      "cross_section_cell": "",
      "form": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 90,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Tavallinen",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Tavallinen"
      },
      "id": 11,
      "inner_diameter": null,
      "material": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7201,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Muovi",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Muovi"
      },
      "n_subducts": null,
      "outer_diameter": 100,
      "subduct_type": "",
      "type": "M100",
      "unit_cost": null
    },
    {
      "availability_end": null,
      "availability_start": null,
      "colour": "Harmaa",
      "cross_section_cell": "",
      "form": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 90,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Tavallinen",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Tavallinen"
      },
      "id": 21,
      "inner_diameter": null,
      "material": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7201,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Muovi",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Muovi"
      },
      "n_subducts": null,
      "outer_diameter": 110,
      "subduct_type": "",
      "type": "M110",
      "unit_cost": null
    },
    {
      "availability_end": null,
      "availability_start": null,
      "colour": "Harmaa",
      "cross_section_cell": "",
      "form": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 90,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Tavallinen",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Tavallinen"
      },
      "id": 31,
      "inner_diameter": null,
      "material": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7201,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Muovi",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Muovi"
      },
      "n_subducts": null,
      "outer_diameter": 140,
      "subduct_type": "",
      "type": "M140",
      "unit_cost": null
    },
    {
      "availability_end": null,
      "availability_start": null,
      "colour": "Harmaa",
      "cross_section_cell": "",
      "form": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 90,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Tavallinen",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Tavallinen"
      },
      "id": 41,
      "inner_diameter": null,
      "material": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7201,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Muovi",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Muovi"
      },
      "n_subducts": null,
      "outer_diameter": 160,
      "subduct_type": "",
      "type": "M160",
      "unit_cost": null
    },
    {
      "availability_end": null,
      "availability_start": null,
      "colour": "Harmaa",
      "cross_section_cell": "",
      "form": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 110,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Kouru",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Kouru"
      },
      "id": 51,
      "inner_diameter": null,
      "material": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7201,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Muovi",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Muovi"
      },
      "n_subducts": null,
      "outer_diameter": 100,
      "subduct_type": "",
      "type": "Kouru",
      "unit_cost": null
    },
    {
      "availability_end": null,
      "availability_start": null,
      "colour": "punainen",
      "cross_section_cell": "",
      "form": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 150,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Arina",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Arina"
      },
      "id": 61,
      "inner_diameter": null,
      "material": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7241,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Betoni",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Betoni"
      },
      "n_subducts": null,
      "outer_diameter": 100,
      "subduct_type": "",
      "type": "Arina",
      "unit_cost": null
    },
    {
      "availability_end": null,
      "availability_start": null,
      "colour": "Harmaa",
      "cross_section_cell": "",
      "form": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 130,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Mersu",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Mersu"
      },
      "id": 71,
      "inner_diameter": null,
      "material": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7201,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Muovi",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Muovi"
      },
      "n_subducts": null,
      "outer_diameter": 100,
      "subduct_type": "",
      "type": "Mersu",
      "unit_cost": null
    },
    {
      "availability_end": null,
      "availability_start": null,
      "colour": "punainen",
      "cross_section_cell": "",
      "form": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 262370,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Lauta",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Lauta"
      },
      "id": 81,
      "inner_diameter": null,
      "material": {
        "availability_end_ts": "2020-12-31T00:00:00Z",
        "availability_start_ts": "2020-01-01T00:00:00Z",
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7241,
        "list_url": "http://keylight.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Betoni",
        "num_value": 10.1,
        "num_value2": 20.2,
        "num_value3": 30.3,
        "num_value4": 40.4,
        "txt": "Betoni"
      },
      "n_subducts": null,
      "outer_diameter": 100,
      "subduct_type": "",
      "type": "Lauta",
      "unit_cost": null
    }
  ],
  "Total": 9
}
Expand All
object
Next
string

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

Prev
string

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

Results
Array of object (ElDuctType)

List of fetched electric duct types

object

Electrical duct type

availability_end
string

Electric Duct availability end date

availability_start
string

Electric availability start date

colour
string

Electric Duct color

cross_section_cell
string

Electric Duct Cross-section cell

form
object

Duct Form

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

inner_diameter
number

Electric Duct inner diameter

material
object

Duct Material

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

n_subducts
integer

Electric Duct subducts number

outer_diameter
number

Electric Duct outer diameter

subduct_type
string

Electric Duct subduct type

type
string

Electric Duct type name

unit_cost
number

Electric Duct unit cost

Total
integer

Total number of electric duct 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?