Documentation Index

Fetch the complete documentation index at: https://support.keypro.fi/llms.txt

Use this file to discover all available pages before exploring further.

2025-11-06 14.00 UTC - There are currently no active events. All systems operational.

Get route connections Excel report

Prev Next
Get
/route-report/

Generates an Excel (xlsx) report for a selected Physical route's connections. Requires a valid result_key from a prior route-query response and the route_index of the desired route within the cached result set. Returns a downloadable .xlsx file containing the requested columns.

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

API Key: Session
Query parameter name
Query parameters
result_key
stringRequired

Cache key from a previous route-query response

route_index
integerRequired

Index of the route in the cached route list (0-based)

columns
stringRequired

JSON-encoded array of column dataIndex values to include in the report. Valid values: route_object, type, identification, usage_state, owner, num_ducts, num_subducts, num_cables, contracts, free_capacity, connected_object, environment

Responses
200

Excel file with route connections data

Headers
Content-Disposition
string
attachment; filename="Route connections_YYYYMMDD.xlsx"
string (binary)
400

Invalid or missing parameters

object
error
string
401

Authentication credentials were not provided

403

Permission denied

404

Route search result not found or expired