Get list of telecom duct types

28 Oct 2024
7 Minutes to read
Contributors

Print
Dark
Light
PDF

Get list of telecom duct types

Updated on 28 Oct 2024
7 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/duct-types/

Operation is used to get a list of telecom duct types. Available from 3.2.10 product version. 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.

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.

{
  "Next": "https://keycom.example.com/api/v2/duct-types/?limit=10&offset=20",
  "Previous": "https://keycom.example.com/api/v2/duct-types/?limit=10",
  "Results": [
    {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "colour": "HARMAA",
      "crossSectionCell": "",
      "favorite": null,
      "form": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 90,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Tavallinen",
        "txt": "Regular"
      },
      "id": 10,
      "innerDiameter": 100.0,
      "innerXDiameter": null,
      "innerYDiameter": null,
      "manufacturer": "",
      "material": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7201,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Muovi",
        "txt": "Plastic"
      },
      "orderNum": 0,
      "outerDiameter": 100.0,
      "outerXDiameter": null,
      "outerYDiameter": null,
      "productCode": "",
      "productCodeAlt": "",
      "sheathColour": null,
      "stripeColour": null,
      "stripeOtherColour": null,
      "subductType": "",
      "subductsNo": null,
      "type": "M100",
      "unitCost": null
    },
    {
      "availability_end_ts": null,
      "availability_start_ts": "2015-01-01T02:56:11Z",
      "colour": "",
      "crossSectionCell": "",
      "favorite": null,
      "form": null,
      "id": 4430,
      "innerDiameter": null,
      "innerXDiameter": null,
      "innerYDiameter": null,
      "manufacturer": "",
      "material": null,
      "orderNum": null,
      "outerDiameter": 1.0,
      "outerXDiameter": null,
      "outerYDiameter": null,
      "productCode": "",
      "productCodeAlt": "",
      "sheathColour": null,
      "stripeColour": null,
      "stripeOtherColour": null,
      "subductType": "",
      "subductsNo": null,
      "type": "Testi tuleva",
      "unitCost": null
    },
    {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "colour": "HARMAA",
      "crossSectionCell": "",
      "favorite": null,
      "form": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 90,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Tavallinen",
        "txt": "Regular"
      },
      "id": 861,
      "innerDiameter": null,
      "innerXDiameter": null,
      "innerYDiameter": null,
      "manufacturer": "",
      "material": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7241,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Betoni",
        "txt": "Concrete"
      },
      "orderNum": null,
      "outerDiameter": 100.0,
      "outerXDiameter": null,
      "outerYDiameter": null,
      "productCode": "",
      "productCodeAlt": "",
      "sheathColour": null,
      "stripeColour": null,
      "stripeOtherColour": null,
      "subductType": "",
      "subductsNo": null,
      "type": "BE100",
      "unitCost": null
    },
    {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "colour": "MUSTA",
      "crossSectionCell": "",
      "favorite": null,
      "form": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 130,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Mersu",
        "txt": "Partitioning duct"
      },
      "id": 1261,
      "innerDiameter": null,
      "innerXDiameter": null,
      "innerYDiameter": null,
      "manufacturer": "",
      "material": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7241,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Betoni",
        "txt": "Concrete"
      },
      "orderNum": null,
      "outerDiameter": 400.0,
      "outerXDiameter": null,
      "outerYDiameter": null,
      "productCode": "",
      "productCodeAlt": "",
      "sheathColour": null,
      "stripeColour": null,
      "stripeOtherColour": null,
      "subductType": "",
      "subductsNo": null,
      "type": "BE400",
      "unitCost": null
    },
    {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "colour": "HARMAA",
      "crossSectionCell": "",
      "favorite": null,
      "form": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 90,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Tavallinen",
        "txt": "Regular"
      },
      "id": 1241,
      "innerDiameter": null,
      "innerXDiameter": null,
      "innerYDiameter": null,
      "manufacturer": "",
      "material": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7241,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Betoni",
        "txt": "Concrete"
      },
      "orderNum": null,
      "outerDiameter": 100.0,
      "outerXDiameter": null,
      "outerYDiameter": null,
      "productCode": "",
      "productCodeAlt": "",
      "sheathColour": null,
      "stripeColour": null,
      "stripeOtherColour": null,
      "subductType": "",
      "subductsNo": null,
      "type": "BE4\"",
      "unitCost": null
    },
    {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "colour": "MINTTU",
      "crossSectionCell": "",
      "favorite": null,
      "form": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 110,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Kouru",
        "txt": "Chute"
      },
      "id": 1281,
      "innerDiameter": null,
      "innerXDiameter": null,
      "innerYDiameter": null,
      "manufacturer": "",
      "material": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7201,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Muovi",
        "txt": "Plastic"
      },
      "orderNum": null,
      "outerDiameter": 50.0,
      "outerXDiameter": null,
      "outerYDiameter": null,
      "productCode": "",
      "productCodeAlt": "",
      "sheathColour": null,
      "stripeColour": null,
      "stripeOtherColour": null,
      "subductType": "",
      "subductsNo": null,
      "type": "M50",
      "unitCost": null
    },
    {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "colour": "HARMAA",
      "crossSectionCell": "",
      "favorite": null,
      "form": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 90,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Tavallinen",
        "txt": "Regular"
      },
      "id": 941,
      "innerDiameter": null,
      "innerXDiameter": null,
      "innerYDiameter": null,
      "manufacturer": "",
      "material": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7201,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Muovi",
        "txt": "Plastic"
      },
      "orderNum": null,
      "outerDiameter": 50.0,
      "outerXDiameter": null,
      "outerYDiameter": null,
      "productCode": "",
      "productCodeAlt": "",
      "sheathColour": null,
      "stripeColour": null,
      "stripeOtherColour": null,
      "subductType": "",
      "subductsNo": null,
      "type": "M50",
      "unitCost": null
    },
    {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "colour": "HARMAA",
      "crossSectionCell": "",
      "favorite": null,
      "form": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 90,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Tavallinen",
        "txt": "Regular"
      },
      "id": 881,
      "innerDiameter": null,
      "innerXDiameter": null,
      "innerYDiameter": null,
      "manufacturer": "",
      "material": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7201,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Muovi",
        "txt": "Plastic"
      },
      "orderNum": null,
      "outerDiameter": 40.0,
      "outerXDiameter": null,
      "outerYDiameter": null,
      "productCode": "",
      "productCodeAlt": "",
      "sheathColour": null,
      "stripeColour": null,
      "stripeOtherColour": null,
      "subductType": "",
      "subductsNo": null,
      "type": "M40",
      "unitCost": null
    },
    {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "colour": "HARMAA",
      "crossSectionCell": "",
      "favorite": null,
      "form": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 90,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Tavallinen",
        "txt": "Regular"
      },
      "id": 901,
      "innerDiameter": null,
      "innerXDiameter": null,
      "innerYDiameter": null,
      "manufacturer": "",
      "material": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7201,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Muovi",
        "txt": "Plastic"
      },
      "orderNum": null,
      "outerDiameter": 30.0,
      "outerXDiameter": null,
      "outerYDiameter": null,
      "productCode": "",
      "productCodeAlt": "",
      "sheathColour": null,
      "stripeColour": null,
      "stripeOtherColour": null,
      "subductType": "",
      "subductsNo": null,
      "type": "M30",
      "unitCost": null
    },
    {
      "availability_end_ts": null,
      "availability_start_ts": null,
      "colour": "HARMAA",
      "crossSectionCell": "",
      "favorite": null,
      "form": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_FORM",
        "id": 110,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
        "logical_txt": "Kouru",
        "txt": "Chute"
      },
      "id": 1221,
      "innerDiameter": null,
      "innerXDiameter": null,
      "innerYDiameter": null,
      "manufacturer": "",
      "material": {
        "availability_end_ts": null,
        "availability_start_ts": null,
        "available": true,
        "groupname": "DUCT_MATERIAL",
        "id": 7241,
        "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/DUCT_MATERIAL/",
        "logical_txt": "Betoni",
        "txt": "Concrete"
      },
      "orderNum": null,
      "outerDiameter": 75.0,
      "outerXDiameter": null,
      "outerYDiameter": null,
      "productCode": "",
      "productCodeAlt": "",
      "sheathColour": null,
      "stripeColour": null,
      "stripeOtherColour": null,
      "subductType": "",
      "subductsNo": null,
      "type": "Kouru",
      "unitCost": null
    }
  ],
  "Total": 54
}

Expand All

object

string (url)

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

string (url)

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

Results

Array of object (DuctType)

List of fetched telecom duct types

object

Telecom duct type

availability_end_ts

string (date-time)

Telecom Duct availability end

availability_start_ts

string (date-time)

Telecom Duct availability start

colour

string

Telecom Duct color

crossSectionCell

string

Telecom Duct Cross-section cell

favorite

boolean

Always show telecom duct type when filtering

form

object (ElDuctTypeForm)

Duct Form

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

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

integer

primary key

innerDiameter

number (float)

Telecom Duct inner diameter

innerXDiameter

number (float)

Telecom Duct inner x-diameter

innerYDiameter

number (float)

Telecom Duct inner y-diameter

manufacturer

string

Telecom Duct manufacturer name

material

object (ElDuctTypeMaterial)

Duct Material

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

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

orderNum

integer

Telecom Duct order number

outerDiameter

number (float)

Telecom Duct outer diameter

outerXDiameter

number (float)

Telecom Duct outer x-diameter

outerYDiameter

number (float)

Telecom Duct outer y-diameter

productCode

string

Telecom Duct product code

productCodeAlt

string

Telecom Duct product code alternative

sheathColour

object (DuctTypeColour)

Duct Colour

groupname

Group name of constant

Valid values[ "KEYCOM_DUCT_COLOR" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

txt

string

Human readable textual representation

stripeColour

object (DuctTypeColour)

Duct Colour

groupname

Group name of constant

Valid values[ "KEYCOM_DUCT_COLOR" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

txt

string

Human readable textual representation

stripeOtherColour

object (DuctTypeColour)

Duct Colour

groupname

Group name of constant

Valid values[ "KEYCOM_DUCT_COLOR" ]

integer

Unique id of constant

list_url

string (url)

Url to fetch all contants from this group

logical_txt

string

Logical textual value

txt

string

Human readable textual representation

subductType

string

Telecom Duct subduct type

subductsNo

integer

Telecom Duct subducts number

type

string

Telecom Duct type name

unitCost

number (float)

Telecom Duct unit cost

Total

integer

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

What's Next

Get list of telecom premises types