Get list of electric cable Connections

29 Aug 2023
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Get list of electric cable Connections

Updated on 29 Aug 2023
2 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/el_cable_connections/

Operation is used to get a list of electric Cable Connections. Available from product version 3.2.2.

Cable Connections 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": [
    {
      "cable": "http://keylight.example.com/api/v2/el_cables/70490/",
      "direction": "E",
      "id": 2601,
      "manhole": null,
      "pole": null,
      "premise": "http://keylight.example.com/api/v2/el_premises/108081/",
      "splice": null,
      "streetlight": null
    }
  ],
  "Total": 1
}

Expand All

object

string

Url to next page of Cable Connections. Null if No next page exist

string

Url to previous page of Cable Connections. Null if No previous page exist

Results

Array of object (ElCableConnection)

List of fetched Cable Connections

object

cable

string

Electric Cable details link

direction

string

which end of the electric cable is object connected (Beginning or End)

Valid values["B","E"]

integer

Primary key

manhole

string

Electric Manhole details link

pole

string

Electric Pole details link

premise

string

Electric Premises details link

splice

string

Electric Splice details link

streetlight

string

Streetlight details link

Total

integer

Total number of Cable Connections

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

Create new electric cable connection