> ## 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.

# Calculate supply interruption affected objects.

> Calculates affected objects, valves to close, and related data for a given
network object.


## OpenAPI

````json POST /keydh-supply-interruption/calculate/
{
  "info": {
    "contact": {
      "email": "keypro@keypro.fi",
      "name": "Keypro Oy",
      "url": "https://keypro.fi/"
    },
    "license": {
      "name": "Copyright (C) Keypro Oy. All rights reserved.",
      "url": "https://www.keypro.fi/"
    },
    "termsOfService": "https://www.keypro.fi/en/terms-of-service",
    "title": "Keyduct REST API",
    "version": "2.0.0"
  },
  "tags": [
    {
      "description": "Task related operations.",
      "name": "Task"
    },
    {
      "description": "Subregion related operations.",
      "name": "Subregion"
    },
    {
      "description": "SAttribute related operations.",
      "name": "SAttribute"
    },
    {
      "description": "Fault related operations.",
      "name": "Fault"
    },
    {
      "description": "Maintenance history related operations.",
      "name": "Maintenance history"
    },
    {
      "description": "Deflection related operations.",
      "name": "Deflection"
    },
    {
      "description": "Fault Component related operations.",
      "name": "Fault Component"
    },
    {
      "description": "Task comment related operations.",
      "name": "Task Comment"
    },
    {
      "description": "FaultComponentFault related operations.",
      "name": "FaultComponentFault"
    },
    {
      "description": "Collection related operations.",
      "name": "Collections"
    },
    {
      "description": "ContactPerson related operations",
      "name": "Contact Person"
    },
    {
      "description": "ContactPersonConnection related operations",
      "name": "Contact Person Connection"
    },
    {
      "description": "Plan related operations.",
      "name": "Plan"
    },
    {
      "description": "FreeArea related operations.",
      "name": "FreeArea"
    },
    {
      "description": "Building address related operations.",
      "name": "Address"
    },
    {
      "description": "Building apartments related operations.",
      "name": "Apartment"
    },
    {
      "description": "Customer data related operations.",
      "name": "Customer"
    },
    {
      "description": "Customer contract related operations.",
      "name": "Customer Contract"
    },
    {
      "description": "Extra attributes related operations.",
      "name": "Extra Attribute"
    },
    {
      "description": "Extra attribute values related operations.",
      "name": "Extra Value"
    },
    {
      "description": "Consumer point related operations.",
      "name": "Consumer Point"
    },
    {
      "description": "Consumer point address link related operations.",
      "name": "Consumer Point Linked Address"
    },
    {
      "description": "Flow Meter related operations.",
      "name": "Flow Meter"
    },
    {
      "description": "Text Constant related operations.",
      "name": "Text Constant"
    },
    {
      "description": "Sn Constant related operations.",
      "name": "Sn Constant"
    },
    {
      "description": "Gas Meter related operations.",
      "name": "Gas Meter"
    },
    {
      "description": "Junction related operations.",
      "name": "Junction"
    },
    {
      "description": "Junction Connection related operations.",
      "name": "Junction Connection"
    },
    {
      "description": "External documents related operations.",
      "name": "External Document"
    },
    {
      "description": "Water duct renovation related operations.",
      "name": "Water Duct Renovation"
    },
    {
      "description": "Sewer duct renovation related operations.",
      "name": "Sewer Duct Renovation"
    },
    {
      "description": "Water duct related operations.",
      "name": "Water Duct"
    },
    {
      "description": "Water other node related operations.",
      "name": "Water Other Node"
    },
    {
      "description": "Water hydrant related operations.",
      "name": "Water Hydrant"
    },
    {
      "description": "Water branch related operations.",
      "name": "Water Branch"
    },
    {
      "description": "Water measuring point related operations.",
      "name": "Water Measuring Point"
    },
    {
      "description": "Fire water station related operations.",
      "name": "Fire Water Station"
    },
    {
      "description": "Water fireplug related operations.",
      "name": "Water Fireplug"
    },
    {
      "description": "Sewer duct related operations.",
      "name": "Sewer Duct"
    },
    {
      "description": "Flow Meter Reading related operations.",
      "name": "Flow Meter Reading"
    },
    {
      "description": "Gas meter reading related operations.",
      "name": "Gas Meter Reading"
    },
    {
      "description": "Gas cable related operations.",
      "name": "Gas Cable"
    },
    {
      "description": "Gas other node related operations.",
      "name": "Gas Other Node"
    },
    {
      "description": "Gas valve related operations.",
      "name": "Gas Valve"
    },
    {
      "description": "Water node related operations.",
      "name": "Water Node"
    },
    {
      "description": "Consumer point property related operations.",
      "name": "Consumer Point Property"
    },
    {
      "description": "Dh manhole related operations.",
      "name": "Dh Manhole"
    },
    {
      "description": "Dh Manhole Link Connection related operations.",
      "name": "Dh Manhole Link Connection"
    },
    {
      "description": "Dh cable related operations.",
      "name": "Dh Cable"
    },
    {
      "description": "Error report related operations.",
      "name": "Error Report"
    },
    {
      "description": "Failure report related operations.",
      "name": "Failure Report"
    },
    {
      "description": "Dh duct related operations.",
      "name": "Dh Duct"
    },
    {
      "description": "Dh conduit related operations.",
      "name": "Dh Conduit"
    },
    {
      "description": "Dh division related operations.",
      "name": "Dh Division"
    },
    {
      "description": "Dh valve related operations.",
      "name": "Dh Valve"
    },
    {
      "description": "Consumer Point User related operations.",
      "name": "Consumer Point User"
    },
    {
      "description": "Consumer point real estate related operations.",
      "name": "Consumer Point Real Estate"
    },
    {
      "description": "Consumer point user email related operations.",
      "name": "Consumer Point User Email"
    },
    {
      "description": "Water pumping station related operations.",
      "name": "Water Pumping Station"
    },
    {
      "description": "Dh Meter Reading related operations.",
      "name": "Dh Meter Reading"
    },
    {
      "description": "Consumer point connection related operations.",
      "name": "Consumer Point Connection"
    },
    {
      "description": "Modeling data related operations.\n\n*NOTE:* Contrary to what is described in chapter 1.5, the base path for all of these operations is `/keyaqua_modeling`\n",
      "name": "Modeling Data"
    },
    {
      "description": "Gas manhole related operations.",
      "name": "Gas Manhole"
    },
    {
      "description": "KeyDh Observation related operations.",
      "name": "KeyDh Observation"
    },
    {
      "description": "KeyDh Supply Interruption related operations.",
      "name": "KeyDh Supply Interruption"
    },
    {
      "description": "KeyDh Supply Interruption Connection related operations.",
      "name": "KeyDh Supply Interruption Connection"
    },
    {
      "description": "Keydh Node related operations.",
      "name": "Keydh Node"
    },
    {
      "description": "Keygas Duct related operations.",
      "name": "Keygas Duct"
    },
    {
      "description": "Real Estate related operations.",
      "name": "Real Estate"
    },
    {
      "description": "Keydh Connection related operations.",
      "name": "Keydh Connection"
    },
    {
      "description": "Water Tank related operations.",
      "name": "Water Tank"
    },
    {
      "description": "Water Valve related operations.",
      "name": "Water Valve"
    },
    {
      "description": "Point related operations.",
      "name": "Point"
    },
    {
      "description": "Sn Modeling related operations.",
      "name": "Sn Modeling"
    },
    {
      "description": "Sewer Manholes v2 related operations.",
      "name": "Sewer Manholes v2"
    },
    {
      "description": "Sewer Ducts related operations.",
      "name": "Sewer Ducts"
    },
    {
      "description": "Sewer Valves related operations.",
      "name": "Sewer Valves"
    },
    {
      "description": "Sewer Pumping Stations related operations.",
      "name": "Sewer Pumping Stations"
    },
    {
      "description": "Sewer Branches related operations.",
      "name": "Sewer Branches"
    },
    {
      "description": "Sewer Measuring Poins related operations.",
      "name": "Sewer Measuring Poins"
    },
    {
      "description": "Sewer Other Nodes related operations.",
      "name": "Sewer Other Nodes"
    },
    {
      "description": "Keydh Conduit Link related operations.",
      "name": "Keydh Conduit Link"
    },
    {
      "description": "Duct condition detail related operations.",
      "name": "Duct Condition Detail"
    },
    {
      "description": "KeyDh Conduit Error related operations.",
      "name": "KeyDh Conduit Error"
    },
    {
      "description": "AquaObjectType related operations.",
      "name": "AquaObjectType"
    },
    {
      "description": "AquaMeasuringPointTypes related operations.",
      "name": "AquaMeasuringPointTypes"
    },
    {
      "description": "AquaPumpType related operations.",
      "name": "AquaPumpType"
    },
    {
      "description": "AquaBranchType related operations.",
      "name": "AquaBranchType"
    },
    {
      "description": "AquaValveType related operations.",
      "name": "AquaValveType"
    },
    {
      "description": "AquaManholeType related operations.",
      "name": "AquaManholeType"
    },
    {
      "description": "AquaDuctType related operations.",
      "name": "AquaDuctType"
    },
    {
      "description": "SnDuctType related operations.",
      "name": "SnDuctType"
    },
    {
      "description": "SnManholeType related operations.",
      "name": "SnManholeType"
    },
    {
      "description": "SnLidType related operations.",
      "name": "SnLidType"
    },
    {
      "description": "Sewer Node related operations.",
      "name": "Sewer Nodes"
    },
    {
      "description": "Sn Control related operations.",
      "name": "Sn Control"
    },
    {
      "description": "KeyDh Shell Type related operations.",
      "name": "KeyDh Shell Type"
    },
    {
      "description": "Sewer Branch Type related operations.",
      "name": "Sewer Branch Type"
    },
    {
      "description": "Sewer Valve Type related operations.",
      "name": "Sewer Valve Type"
    }
  ],
  "paths": {
    "/keydh-supply-interruption/calculate/": {
      "post": {
        "description": "Calculates affected objects, valves to close, and related data for a given\nnetwork object.\n",
        "operationId": "calculateKeyDhSupplyInterruption",
        "parameters": [
          {
            "in": "body",
            "name": "CalculateRequest",
            "required": "true",
            "schema": {
              "properties": {
                "target_pk": {
                  "description": "Primary key of the target network object.",
                  "type": "integer"
                },
                "target_type": {
                  "description": "Type of the target object.",
                  "enum": [
                    "DH_CONDUIT",
                    "DH_VALVE",
                    "SN_WATER_DUCT",
                    "SN_WATER_NODE"
                  ],
                  "type": "string"
                }
              },
              "required": [
                "target_pk",
                "target_type"
              ],
              "type": "object"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "Calculation result.",
            "examples": {
              "application/json": {
                "affected_objects": [
                  {
                    "duct_volume": null,
                    "id": null,
                    "object_ct": "41",
                    "object_identification": "277446",
                    "object_pk": "277446",
                    "object_type": "WaterDuct"
                  },
                  {
                    "duct_volume": null,
                    "id": null,
                    "object_ct": "45",
                    "object_identification": "322388",
                    "object_pk": "322388",
                    "object_type": "WaterNode"
                  }
                ],
                "consumerpoint_count": "0",
                "duct_volume": "0.0",
                "history": "",
                "interruption_address": null,
                "interruption_description": "",
                "interruption_net_type": "1",
                "observations": [],
                "power_sum": "0.0",
                "valves_to_close": [
                  {
                    "id": null,
                    "is_valve_to_close": "true",
                    "manhole_identification": null,
                    "manhole_pk": null,
                    "manhole_type": null,
                    "object_ct": "45",
                    "object_identification": "322408",
                    "object_pk": "322408",
                    "object_type": "WaterValve"
                  }
                ],
                "water_flow_sum": "0.0"
              }
            },
            "schema": {
              "properties": {
                "affected_objects": {
                  "description": "List of affected network objects.",
                  "items": {
                    "properties": {
                      "duct_volume": {
                        "type": "number",
                        "x-nullable": "true"
                      },
                      "id": {
                        "description": "SupplyInterruptionConnection ID if already saved, otherwise null.",
                        "type": "integer",
                        "x-nullable": "true"
                      },
                      "object_ct": {
                        "type": "integer"
                      },
                      "object_identification": {
                        "type": "string"
                      },
                      "object_pk": {
                        "type": "integer"
                      },
                      "object_type": {
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array"
                },
                "consumerpoint_count": {
                  "type": "integer"
                },
                "duct_volume": {
                  "type": "number"
                },
                "interruption_net_type": {
                  "description": "Network type ID.",
                  "type": "integer"
                },
                "power_sum": {
                  "type": "number"
                },
                "valves_to_close": {
                  "description": "List of valves that should be closed.",
                  "items": {
                    "properties": {
                      "id": {
                        "type": "integer",
                        "x-nullable": "true"
                      },
                      "is_valve_to_close": {
                        "type": "boolean"
                      },
                      "object_ct": {
                        "type": "integer"
                      },
                      "object_identification": {
                        "type": "string"
                      },
                      "object_pk": {
                        "type": "integer"
                      },
                      "object_type": {
                        "type": "string"
                      }
                    },
                    "type": "object"
                  },
                  "type": "array"
                },
                "water_flow_sum": {
                  "type": "number"
                }
              },
              "type": "object"
            }
          },
          "400": {
            "description": "Validation error or the target is a blind/ignored conduit.",
            "examples": {
              "application/json": {
                "detail": "The picked object is a blind. Please pick a different object."
              }
            },
            "schema": {
              "properties": {
                "detail": {
                  "type": "string"
                }
              },
              "type": "object"
            }
          },
          "401": {
            "$ref": "#/responses/Http401"
          },
          "404": {
            "description": "Target object not found.",
            "examples": {
              "application/json": {
                "detail": "Object not found."
              }
            },
            "schema": {
              "properties": {
                "detail": {
                  "type": "string"
                }
              },
              "type": "object"
            }
          }
        },
        "security": [
          {
            "Token": []
          }
        ],
        "summary": "Calculate supply interruption affected objects.",
        "tags": [
          "KeyDh Supply Interruption"
        ]
      }
    }
  }
}
````