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

Overview

Prev Next

Keyduct REST API

This documentation describes Keyduct REST API v2.

Product version

This documentations is valid for release version: 2025.3

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

• Collections : Collection related operations.

• Contact Person : ContactPerson related operations

• Contact Person Connection : ContactPersonConnection related operations

• Plan : Plan related operations.

• FreeArea : FreeArea related operations.

• Address : Building address related operations.

• Apartment : Building apartments related operations.

• Customer : Customer data related operations.

• Extra Attribute : Extra attributes related operations.

• Extra Value : Extra attribute values related operations.

• Consumer Point : Consumer point related operations.

• Consumer Point Linked Address : Consumer point address link related operations.

• Flow Meter : Flow Meter related operations.

• Text Constant : Text Constant related operations.

• Sn Constant : Sn Constant related operations.

• Gas Meter : Gas Meter related operations.

• Junction : Junction related operations.

• Junction Connection : Junction Connection related operations.

• External Document : External documents related operations.

• Water Duct Renovation : Water duct renovation related operations.

• Sewer Duct Renovation : Sewer duct renovation related operations.

• Water Duct : Water duct related operations.

• Water Other Node : Water other node related operations.

• Water Hydrant : Water hydrant related operations.

• Water Branch : Water branch related operations.

• Water Measuring Point : Water measuring point related operations.

• Fire Water Station : Fire water station related operations.

• Water Fireplug : Water fireplug related operations.

• Sewer Duct : Sewer duct related operations.

• Flow Meter Reading : Flow Meter Reading related operations.

• Gas Meter Reading : Gas meter reading related operations.

• Gas Cable : Gas cable related operations.

• Gas Other Node : Gas other node related operations.

• Gas Valve : Gas valve related operations.

• Water Node : Water node related operations.

• Consumer Point Property : Consumer point property related operations.

• Dh Manhole : Dh manhole related operations.

• Dh Manhole Link Connection : Dh Manhole Link Connection related operations.

• Dh Cable : Dh cable related operations.

• Error Report : Error report related operations.

• Failure Report : Failure report related operations.

• Dh Duct : Dh duct related operations.

• Dh Conduit : Dh conduit related operations.

• Dh Division : Dh division related operations.

• Dh Valve : Dh valve related operations.

• Consumer Point User : Consumer Point User related operations.

• Consumer Point Real Estate : Consumer point real estate related operations.

• Consumer Point User Email : Consumer point user email related operations.

• Water Pumping Station : Water pumping station related operations.

• Dh Meter Reading : Dh Meter Reading related operations.

• Consumer Point Connection : Consumer point connection related operations.

• Modeling Data : Modeling data related operations.

NOTE: Contrary to what is described in chapter 1.5, the base path for all of these operations is /keyaqua_modeling

• Gas Manhole : Gas manhole related operations.

• KeyDh Observation : KeyDh Observation related operations.

• Keydh Node : Keydh Node related operations.

• Keygas Duct : Keygas Duct related operations.

• Real Estate : Real Estate related operations.

• KeyUv Component : KeyUv Component related operations.

• KeyUv Fault Component : KeyUv Fault Component related operations.

• KeyUv Fault : KeyUv Fault related operations.

• KeyUv SAttribute : KeyUv SAttribute related operations.

• KeyUv State : KeyUv State related operations.

• KeyUv SubRegion : KeyUv SubRegion related operations.

• KeyUv Task : KeyUv Task related operations.

• Keydh Connection : Keydh Connection related operations.

• Water Tank : Water Tank related operations.

• Water Valve : Water Valve related operations.

• Point : Point related operations.

• Sn Modeling : Sn Modeling related operations.

• Sewer Manholes v2 : Sewer Manholes v2 related operations.

• Sewer Ducts : Sewer Ducts related operations.

• Sewer Valves : Sewer Valves related operations.

• Sewer Pumping Stations : Sewer Pumping Stations related operations.

• Sewer Branches : Sewer Branches related operations.

• Sewer Measuring Poins : Sewer Measuring Poins related operations.

• Sewer Other Nodes : Sewer Other Nodes related operations.

• Keydh Conduit Link : Keydh Conduit Link related operations.

• Duct Condition Detail : Duct condition detail related operations.

• KeyDh Conduit Error : KeyDh Conduit Error related operations.

• Task Comment : Task comment related operations.

• AquaObjectType : AquaObjectType related operations.

Consumes

• application/json

Produces

• application/json

Documentation generation

This documentation is automatically generated from KeyCom Swagger API definitions (OpenAPI 2.0)