Get routefollower results

28 Oct 2024
9 Minutes to read
Contributors

Print
Dark
Light
PDF

Get routefollower results

Updated on 28 Oct 2024
9 Minutes to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Get

/routefollower/

Operation is used to retrieve details of a route and it's components with given parameters. Required parameters are either 1. source_ids and object_name or 2. object_id and object_name/ctid. Example request url would be /routefollower/?object_id=2576290&object_name=terminal&over_cc=True, where object_id refers to the primary key (id) Terminal where route following starts from. You can also use thread or connector primary keys as source_ids, example: /routefollower/?source_ids=103920,103930&object_name=terminal&over_cc=True, where source_ids refer to ccp primary keys (id).

Available from product version 3.0.24.

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Query parameters

object_id

integer

Primary key (id) of the object which contains the thread/connector to follow. For example id of a cable

source_ids

integerRequired

Primary keys (id) of the threads or connectors to follow. Can be multiple, comma separated

object_name

stringRequired

Name of the object type which contains the thread/connector to follow, lowercase. For example, "cable"

Valid values[ "cable", "terminal" ]

ctid

integer

ContentType id for the cable or terminal used, use /api/v2/object-types/ endpoint to get these

logical_dir

integer

Logical direction to follow. 1 for ascending, 2 for descending. For both directions default is -1.

Valid values[ 1, 2 ]

Default-1

over_physical

boolean

Follow over physical connections

Defaulttrue

over_cc

boolean

Follow over cross connections

Defaultfalse

over_log

boolean

Follow over logical connections

Defaultfalse

loops

boolean

Show loops and/or coils

Defaultfalse

distance

number (float)

Numeric length to stop following route

Defaultinfinite

thread_start_num

integer

Number of the thread/connector to start route following with

Default1

thread_end_num

integer

Number of the thread/connector to end route following to

connector_name

string

Name of the device connector to follow

stop_nearest_ccp

boolean

Stop to nearest cross connection point of the route

Defaultfalse

srs

string

Coordinate system to transform location to.

Example: srs=epsg:4326

Responses

200

List of routes

{
  "Results": [
    {
      "components": [
        {
          "attenuation": 0.05,
          "connectionObject": {
            "connectionConstState": {
              "availability_end_ts": "2020-12-31",
              "availability_start_ts": "2020-01-01",
              "available": true,
              "groupname": "KN_CONST_STATE",
              "id": 6070,
              "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/KN_CONST_STATE/",
              "logical_txt": "Suunniteltu",
              "num_value": 10.1,
              "num_value2": 20.2,
              "num_value3": 30.3,
              "num_value4": 40.4,
              "txt": "Suunniteltu"
            },
            "connectionNo": 1,
            "connectionOwner": {
              "availability_end_ts": "2020-12-31",
              "availability_start_ts": "2020-01-01",
              "available": true,
              "groupname": "CABLE_OWNER",
              "id": 250770,
              "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/CABLE_OWNER/",
              "logical_txt": "Keypro",
              "num_value": 10.1,
              "num_value2": 20.2,
              "num_value3": 30.3,
              "num_value4": 40.4,
              "txt": "Keypro"
            },
            "connectionType": {
              "availability_end_ts": "2020-12-31",
              "availability_start_ts": "2020-01-01",
              "available": true,
              "groupname": "THREAD_TYPE",
              "id": 413070,
              "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/THREAD_TYPE/",
              "logical_txt": "SM 9/125",
              "num_value": 10.1,
              "num_value2": 20.2,
              "num_value3": 30.3,
              "num_value4": 40.4,
              "txt": "SM 9/125"
            },
            "connectionUsageState": {
              "availability_end_ts": "2020-12-31",
              "availability_start_ts": "2020-01-01",
              "available": null,
              "groupname": null,
              "id": null,
              "list_url": null,
              "logical_txt": null,
              "num_value": 10.1,
              "num_value2": 20.2,
              "num_value3": 30.3,
              "num_value4": 40.4,
              "txt": null
            },
            "id": 17637054,
            "type": "threaddetail",
            "url": null
          },
          "detailConnection": {
            "detailConnId": null,
            "url": null
          },
          "id": "1|root - 17637054",
          "location": "SRID=4326;LINESTRING Z (26.3676653649416863 60.4971100458688227 0.0000000000000000, 26.3680253882916169 60.4970638176940980 0.0000000000000000)",
          "relatedCircuits": [],
          "routeLength": 20.4,
          "routeObject": {
            "id": 3336230,
            "identification": "omcable",
            "length": 20.4,
            "owner": {
              "availability_end_ts": "2020-12-31",
              "availability_start_ts": "2020-01-01",
              "available": true,
              "groupname": "CABLE_OWNER",
              "id": 250770,
              "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/CABLE_OWNER/",
              "logical_txt": "Keypro",
              "num_value": 10.1,
              "num_value2": 20.2,
              "num_value3": 30.3,
              "num_value4": 40.4,
              "txt": "Keypro"
            },
            "subType": "https://keycom.example.com/api/v2/cabletypes/35370/",
            "type": "Kaapeli",
            "url": "https://keycom.example.com/api/v2/cables/3336230/",
            "usageState": {
              "availability_end_ts": "2020-12-31",
              "availability_start_ts": "2020-01-01",
              "available": null,
              "groupname": null,
              "id": null,
              "list_url": null,
              "logical_txt": null,
              "num_value": 10.1,
              "num_value2": 20.2,
              "num_value3": 30.3,
              "num_value4": 40.4,
              "txt": null
            }
          }
        },
        {
          "attenuation": 0.02,
          "connectionObject": {
            "connectionConstState": null,
            "connectionNo": "1",
            "connectionOwner": null,
            "connectionType": null,
            "connectionUsageState": null,
            "id": 75129370,
            "type": "crossconnectionpoint",
            "url": null
          },
          "detailConnection": {
            "detailConnId": 2473613,
            "url": null
          },
          "id": "2473613 - 75129370",
          "location": "SRID=4326;POINT Z (26.3684861544175497 60.4970046522498563 0.0000000000000000)",
          "relatedCircuits": [
            {
              "relatedCircuitId": "YHT-178760:test",
              "url": "https://keycom.example.com/api/v2/circuits/178760/"
            }
          ],
          "routeLength": 67.0,
          "routeObject": {
            "id": 2913570,
            "identification": "om3",
            "length": 46.6,
            "owner": {
              "availability_end_ts": "2020-12-31",
              "availability_start_ts": "2020-01-01",
              "available": true,
              "groupname": "PREM_OWNER",
              "id": 550,
              "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/PREM_OWNER/",
              "logical_txt": "Elisa",
              "num_value": 10.1,
              "num_value2": 20.2,
              "num_value3": 30.3,
              "num_value4": 40.4,
              "txt": "Elisa"
            },
            "subType": "https://keycom.example.com/api/v2/types/33250/",
            "type": "Tilaajapiste",
            "url": "https://keycom.example.com/api/v2/premises/2913570/",
            "usageState": {
              "availability_end_ts": "2020-12-31",
              "availability_start_ts": "2020-01-01",
              "available": true,
              "groupname": "PREM_STATE",
              "id": 14601,
              "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/PREM_STATE/",
              "logical_txt": "Käytössä",
              "num_value": 10.1,
              "num_value2": 20.2,
              "num_value3": 30.3,
              "num_value4": 40.4,
              "txt": "Käytössä"
            }
          }
        }
      ],
      "connectionIds": [
        {
          "id": 17637054,
          "type": "threaddetail",
          "url": null
        },
        {
          "id": 75128410,
          "type": "crossconnectionpoint",
          "url": null
        },
        {
          "id": 75129370,
          "type": "crossconnectionpoint",
          "url": null
        },
        {
          "id": 75129670,
          "type": "crossconnectionpoint",
          "url": null
        },
        {
          "id": 75128710,
          "type": "crossconnectionpoint",
          "url": null
        },
        {
          "id": 17637069,
          "type": "threaddetail",
          "url": null
        },
        {
          "id": 1108330,
          "type": "splice",
          "url": null
        },
        {
          "id": 18512402,
          "type": "threaddetail",
          "url": null
        }
      ],
      "endpoint": {
        "identification": "Kaapeli omcable",
        "location": "SRID=4326;LINESTRING Z (26.3680253882916169 60.4970638176940980 0.0000000000000000, 26.3684861544196600 60.4970046522067832 0.0000000000000000)",
        "objectId": 3480650,
        "thread": 16,
        "url_main": "https://keycom.example.com/api/v2/cables/3480650/",
        "url_sub": null
      }
    },
    {
      "components": [
        {
          "attenuation": null,
          "connectionObject": {
            "connectionConstState": null,
            "connectionNo": "",
            "connectionOwner": null,
            "connectionType": null,
            "connectionUsageState": null,
            "id": 1108330,
            "type": "splice",
            "url": null
          },
          "detailConnection": {
            "detailConnId": 2587554,
            "url": null
          },
          "id": "2587554 - 1108330",
          "location": "SRID=4326;POINT Z (26.3680253882958624 60.4970638176586135 0.0000000000000000)",
          "relatedCircuits": [],
          "routeLength": 20.4,
          "routeObject": {
            "id": 1108330,
            "identification": "43652",
            "length": 0.0,
            "owner": {
              "availability_end_ts": "2020-12-31",
              "availability_start_ts": "2020-01-01",
              "available": null,
              "groupname": null,
              "id": null,
              "list_url": null,
              "logical_txt": null,
              "num_value": 10.1,
              "num_value2": 20.2,
              "num_value3": 30.3,
              "num_value4": 40.4,
              "txt": null
            },
            "subType": null,
            "type": "Jatkos",
            "url": null,
            "usageState": {
              "availability_end_ts": "2020-12-31",
              "availability_start_ts": "2020-01-01",
              "available": true,
              "groupname": "SPLICE_STATE",
              "id": 15001,
              "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/SPLICE_STATE/",
              "logical_txt": "Suunniteltu",
              "num_value": 10.1,
              "num_value2": 20.2,
              "num_value3": 30.3,
              "num_value4": 40.4,
              "txt": "Suunniteltu"
            }
          }
        },
        {
          "attenuation": null,
          "connectionObject": {
            "connectionConstState": null,
            "connectionNo": "1",
            "connectionOwner": null,
            "connectionType": null,
            "connectionUsageState": null,
            "id": 75129370,
            "type": "crossconnectionpoint",
            "url": null
          },
          "detailConnection": {
            "detailConnId": 2587538,
            "url": null
          },
          "id": "2587538 - 75129370",
          "location": "SRID=4326;POINT Z (26.3684861544175497 60.4970046522498563 0.0000000000000000)",
          "relatedCircuits": [
            {
              "relatedCircuitId": "YHT-178760:test",
              "url": "https://keycom.example.com/api/v2/circuits/178760/"
            }
          ],
          "routeLength": 46.6,
          "routeObject": {
            "id": 2913570,
            "identification": "om3",
            "length": 0.0,
            "owner": {
              "availability_end_ts": "2020-12-31",
              "availability_start_ts": "2020-01-01",
              "available": true,
              "groupname": "PREM_OWNER",
              "id": 550,
              "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/PREM_OWNER/",
              "logical_txt": "Elisa",
              "num_value": 10.1,
              "num_value2": 20.2,
              "num_value3": 30.3,
              "num_value4": 40.4,
              "txt": "Elisa"
            },
            "subType": "https://keycom.example.com/api/v2/types/33250/",
            "type": "Tilaajapiste",
            "url": "https://keycom.example.com/api/v2/premises/2913570/",
            "usageState": {
              "availability_end_ts": "2020-12-31",
              "availability_start_ts": "2020-01-01",
              "available": true,
              "groupname": "PREM_STATE",
              "id": 14601,
              "list_url": "https://keycom.example.com/api/v2/txt_constants/groupname/PREM_STATE/",
              "logical_txt": "Käytössä",
              "num_value": 10.1,
              "num_value2": 20.2,
              "num_value3": 30.3,
              "num_value4": 40.4,
              "txt": "Käytössä"
            }
          }
        }
      ],
      "connectionIds": [
        {
          "id": 17637054,
          "type": "threaddetail",
          "url": null
        },
        {
          "id": 1108330,
          "type": "splice",
          "url": null
        },
        {
          "id": 18512387,
          "type": "threaddetail",
          "url": null
        },
        {
          "id": 75129370,
          "type": "crossconnectionpoint",
          "url": null
        },
        {
          "id": 75128410,
          "type": "crossconnectionpoint",
          "url": null
        }
      ],
      "endpoint": {
        "identification": "Tilaajapiste om1 > om1-dev",
        "location": "SRID=4326;POINT Z (26.3676653649416863 60.4971100458688227 0.0000000000000000)",
        "objectId": 2913510,
        "thread": "1",
        "url_main": "https://keycom.example.com/api/v2/premises/2913510/",
        "url_sub": "https://keycom.example.com/api/v2/devices/2576290/"
      }
    }
  ]
}

Array of object

object

components

Array of object

object

attenuation

number (float)

Attenuation at this point of the route

connectionObject

object

connectionConstState

object (ConstructionState)

Txt constants construction state

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

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

connectionNo

integer

Connector/thread number

connectionOwner

object (ConnectionOwner)

Connection usage state

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

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

connectionType

object (ConnectionType)

Connection type

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

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

connectionUsageState

object (ConnectionUsageState)

Connection usage state

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

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 for a connection object of a route component

type

string

Connector/thread type as text

url

string (url)

Link to the API endpoint of a connection object or null if endpoint not active

detailConnection

object

detailConnId

integer

Primary key of detail connection

url

string (url)

Link to Detail connection API endpoint or null if endpoint not active

string

Identifier for the current route

location

string (ewkt)

Geographical location

relatedCircuits

Array of object

object

relatedCircuitId

string

Identification of a circuit and it's section

url

string (url)

Link to Circuit API or null if endpoint not active

routeLength

number (float)

Total length of the route

routeObject

object

integer

Primary key of the main route object

identification

string

Name/identification for the main route object

length

number (float)

Length of the object

owner

object

Owner of the main object

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

string

Group name of constant. Same as groupname parameter.

Valid values[ "CABLE_OWNER", "PREM_OWNER", "SPLICE_OWNER" ]

integer

Unique id of constant

list_url

string (url)

Link to corresponding owner endpoint

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 (translated)

subType

string (url)

Link to the API endpoint of an object subtype, for example device type

type

string

Main object type of the route object (Cable, Premise...)

Valid values[ "Premise", "Cable", "Splice" ]

url

string (url)

Link to the API endpoint of a main route object or null if endpoint not active

usageState

object

Usage state of the main object

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

string

Group name of constant. Same as groupname parameter.

Valid values[ "CABLE_STATE", "PREM_STATE", "SPLICE_STATE" ]

integer

Unique id of constant

list_url

string (url)

Link to corresponding usageState endpoint

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 (translated)

connectionIds

Array of object

object

integer

Primary key of a connection

type

string

Type of a connection

url

string (url)

Link to the API endpoint of a connection or null if endpoint not active

endpoint

object

identification

string

Name/identification of the endpoint object and it's device hierarchy if any

location

string (ewkt)

Geographical location

objectId

integer

Primary key of endpoint object

thread

string

Name or number of the endpoint thread/connector

url_main

string (url)

Link to the API endpoint of a route endpoint object or null if endpoint not active

url_sub

string (url)

Link to the API endpoint of a route endpoint sub object (such as device) or null if endpoint not active

401

Authentication credentials are missing or invalid

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

object

details

string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}

object

details

string

Detailed description of error

Was this article helpful?

What's Next

Create new service area