Get list of electric conduit links
  • 29 Aug 2023
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Get list of electric conduit links

  • Dark
    Light
  • PDF

Article summary

Get
/el_conduitlinks/

Operation is used to get a list of electric conduit links. Available from product version 3.2.2.

Electric Conduit Links 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": [
    {
      "b_measure": 0,
      "cable": 2410,
      "conduit": 1210,
      "duct": null,
      "duct_number": null,
      "h_measure": 700,
      "id": 811
    },
    {
      "b_measure": 10,
      "cable": null,
      "conduit": 1210,
      "duct": 801,
      "duct_number": 1,
      "h_measure": 700,
      "id": 801
    }
  ],
  "Total": 2
}
Expand All
object
Next
string

Url to next page of electric conduit links list. Null if No next page exist

Prev
string

Url to previous page of electric conduit links list. Null if No previous page exist

Results
Array of object (ElConduitLink)

List of fetched Electric Conduit Links

object
b_measure
integer

position b-measure

cable
string

Electric Cable details link

conduit
string

Electric Conduit details link

duct
string

Electric Duct details link

duct_number
integer

Electric Duct number

h_measure
integer

position h-measure

id
integer

Primary key

Total
integer

Total number of Electric Conduit Links

401

Authentication credentials are missing or invalid

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

Detailed description of error


Was this article helpful?