Overview

KeyCom REST API

This documentation describes KeyCom REST API v2.

Product version

This documentations is valid for release version: 2024.2

Version information

Version : 2.0.0

Contact information

Contact : Keypro Oy

Contact Email : keypro@keypro.fi

License information

License : Copyright © Keypro Oy. All rights reserved.

License URL : https://www.keypro.fi/

Terms of service : https://www.keypro.fi/en/terms-of-service

URI scheme

BasePath : /api/v2

Tags

• Address : Building address related operations.

• Address alias : Address aliases related operations

• Apartment : Building apartments related operations.

• Attached Document : Attached Documents related operations.

• Cable : Telecom Cable related operations.

• Circuit : Circuit related operations.

• Circuit Connection : Circuit logical reservations related operations.

• Circuit faults : Circuit faults related operations.

• Circuit Location : Circuit installation location related operations.

• Circuit Physical Reservation : Circuit physical reservations related operations.

• Circuit Reservation Data : Circuit reservation data view and search operations.

• Circuit Section : Circuit section related operations.

• Circuit Services : Operations provided by micro services.

• Collections : Collection related operations.

• Contract : Contract related operations.

• Contract Link : Contract link related operations.

• Create connections : Operation used to create new connections.

• Cross connection point : Cross connection point related operations.

• Customer : Customer data related operations.

• Device : Device related operations.

• Device Group : Device Group related operations.

• Exchange Area : Exchange Area related operations.

• External Document : External documents related operations.

• Extra Attribute : Extra attributes related operations.

• Extra Value : Extra attribute values related operations.

• FreeArea : FreeArea related operations.

• FreeLine : FreeLine related operations.

• Logical connections : Logical connections related operations.

• Manhole : Telecom Manhole related operations.

• Passed Services : Passed Services related operations.

• Plan : Plan related operations.

• Point : Point objects related operations.

• Pole : Pole related operations.

• Routefollower : Routefollower related operations.

• Service Area : Service Area related operations.

• Source system address : External source system derived address related operations.

• Source system apartment : External source system derived apartment related operations.

• Splice : Telecom Splice related operations.

• Supercable : Telecom Supercable related operations.

• Telecom Area : Telecom Area related operations.

• Telecom Cable Connection : Operations related to connecting Cables and endpoints.

• Telecom Conduit : Telecom Conduit related operations.

• Telecom Conduit Connection : Operations related to connecting Conduits and endpoints.

• Telecom Conduit Link : Operations related to putting Telecom Cables and Ducts into Conduits.

• Telecom Duct : Telecom Duct related operations.

• Telecom Duct Connection : Operations related to connecting Telecom Ducts to Telecom Premises or Manhole.

• Telecom Duct Link : Operations related to putting Telecom Cables into Ducts.

• Telecom premises : Telecom premises related operations.

• Terminal type : Terminal types related operations.

• TxtConstant : TxtConstants related operations.

Consumes

• application/json

Produces

• application/json

Documentation generation

This documentation is automatically generated from KeyCom Swagger API definitions

(OpenAPI 2.0)