Get list of Duct Groups

28 Oct 2024
3 Minutes to read
Contributors

Print
Dark
Light
PDF

Get list of Duct Groups

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

/duct-groups/

Operation is used to get a list of Duct Groups. Available from product version 2024.4.

Duct Groups 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": "http://example.com/api/v2/duct-groups/?limit=10&offset=10",
  "Previous": null,
  "Results": [
    {
      "ductRows": [
        {
          "bMeasure": 0.0,
          "ductHierarchy": "001",
          "ductOwner": null,
          "ductRenter": null,
          "ductState": {
            "availability_end_ts": null,
            "availability_start_ts": null,
            "available": true,
            "groupname": "DUCT_STATE",
            "id": 670,
            "list_url": "http://example.com/api/v2/txt_constants/groupname/DUCT_STATE/",
            "logical_txt": "Suunniteltu",
            "num_value": 2.0,
            "num_value2": null,
            "num_value3": 1.0,
            "num_value4": null,
            "txt": "Planned"
          },
          "ductType": {
            "availability_end_ts": null,
            "availability_start_ts": null,
            "color": "Sininen",
            "crossSectionCell": "",
            "favorite": false,
            "form": {
              "availability_end_ts": null,
              "availability_start_ts": null,
              "available": true,
              "groupname": "DUCT_FORM",
              "id": 90,
              "list_url": "http://example.com/api/v2/txt_constants/groupname/DUCT_FORM/",
              "logical_txt": "Tavallinen",
              "num_value": 0.0,
              "num_value2": null,
              "num_value3": null,
              "num_value4": null,
              "txt": "Regular"
            },
            "id": 71250,
            "innerDiameter": 21.0,
            "innerXDiameter": 21.0,
            "innerYDiameter": 21.0,
            "listUrl": "http://example.com/api/v2/duct-types/",
            "manufacturer": "",
            "material": null,
            "orderNum": null,
            "outerDiameter": 23.0,
            "outerXDiameter": 23.0,
            "outerYDiameter": 23.0,
            "productCode": "",
            "productCodeAlt": "",
            "sheathColour": {
              "availability_end_ts": null,
              "availability_start_ts": null,
              "available": true,
              "groupname": "KEYCOM_DUCT_COLOR",
              "id": 410710,
              "list_url": "http://example.com/api/v2/txt_constants/groupname/KEYCOM_DUCT_COLOR/",
              "logical_txt": "Blue",
              "num_value": null,
              "num_value2": null,
              "num_value3": null,
              "num_value4": null,
              "txt": "Sininen"
            },
            "stripeColour": null,
            "stripeOtherColour": null,
            "subductType": "",
            "subductsNo": null,
            "type": "DB 7x7/3,5mm",
            "unitCost": null
          },
          "hMeasure": -700.0,
          "id": 1,
          "identification": "",
          "installYear": null
        }
      ],
      "id": 1,
      "name": "DB 7x7/3,5mm SININEN",
      "remarks": "rest-test-ductgroup-update"
    },
    {
      "ductRows": [],
      "id": 21,
      "name": "DB 7x7/3,5mm VALKOINEN",
      "remarks": ""
    },
    {
      "ductRows": [],
      "id": 101,
      "name": "Unnamed group #101",
      "remarks": ""
    },
    {
      "ductRows": [],
      "id": 141,
      "name": "Unnamed group #141",
      "remarks": ""
    },
    {
      "ductRows": [],
      "id": 161,
      "name": "Unnamed group #161",
      "remarks": ""
    },
    {
      "ductRows": [],
      "id": 181,
      "name": "Unnamed group #181",
      "remarks": ""
    },
    {
      "ductRows": [],
      "id": 201,
      "name": "Unnamed group #201",
      "remarks": ""
    },
    {
      "ductRows": [],
      "id": 221,
      "name": "Unnamed group #221",
      "remarks": ""
    },
    {
      "ductRows": [],
      "id": 241,
      "name": "testigroup",
      "remarks": ""
    },
    {
      "ductRows": [],
      "id": 261,
      "name": "Unnamed group #261",
      "remarks": ""
    }
  ],
  "Total": 44
}

Expand All

object

string (url)

Url to next page of Duct Groups list. Null if No next page exist

string (url)

Url to previous page of Duct Groups list. Null if No previous page exist

Results

Array of object (DuctGroup)

List of fetched Duct Groups

object

Duct Group

ductRows

Array of object (DuctGroupRow)

Duct group rows

object

Duct Group Row

bMeasure

number (float)

B-measure

ductHierarchy

string

Duct hierarchy

ductOwner

string

Duct owner

ductRenter

string

Duct renter

ductState

string

Duct state

ductType

string

Duct type

hMeasure

number (float)

H-measure

integer

Unique id of duct group row

identification

string

Identification

installYear

integer

Installation year

integer

Unique id of duct group

name

string

Name of the duct group

remarks

string

Remarks

Total

integer

Total number of Duct Group in the list

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

Update Duct Group partially