Get list of Cable Appendixes

2 minute(s) read

Get

/cable-appendixes/

Operation is used to get a list of Cable Appendixes. A Cable Appendix represents a connection between a Cable and a loop.

Cable Appendixes can be filtered by giving filtering parameters at HTTP querystring (see parameters).

Available from product version 2026.1.0.

Security

API Key: Token

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://example.keypro.fi/api/v2/cable-appendixes/?limit=10&offset=0",
  "Previous": null,
  "Results": [
    {
      "cable": "https://example.keypro.fi/api/v2/cables/5750790/",
      "id": 1001,
      "point": "https://example.keypro.fi/api/v2/keycore-points/8801/"
    },
    {
      "cable": "https://example.keypro.fi/api/v2/cables/5750791/",
      "id": 1002,
      "point": "https://example.keypro.fi/api/v2/keycore-points/8802/"
    },
    {
      "cable": "https://example.keypro.fi/api/v2/cables/5750792/",
      "id": 1003,
      "point": "https://example.keypro.fi/api/v2/keycore-points/8803/"
    }
  ],
  "Total": 3
}

Expand All

object

string (url)

Url to next page of Cable Appendixes. Null if no next page exists

string (url)

Url to previous page of Cable Appendixes. Null if no previous page exists

Results

Array of object (CableAppendix)

List of fetched Cable Appendixes

object

A Cable Appendix represents a connection between a Cable and a loop. When a CableAppendix is created, the loop's length is added to the Cable's extra_length. When deleted, the loop's length is removed from the Cable's extra_length.

cable

string (uri)

Hyperlink (URL reference) to the Cable associated with this appendix.

integer

Primary key

point

string (uri)

Hyperlink (URL reference) to the loop associated with this appendix.

Total

integer

Total number of Cable Appendixes

401

Authentication credentials are missing or invalid

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

object

details

string

Detailed description of error