Get list of KeyDh Supply Interruption Connections.

  • 10 minute(s) read
Prev Next
Get
/keydh-supply-interruption-connection/

Operation is used to get a list of KeyDh Supply Interruption Connection that are referenced in the system. Available from version 2025.3.

Security
API Key: Token
Header parameter nameAuthorization

Token issued for API consumer.

Responses
200

A result KeyDh Supply Interruption Connection.

{
  "Next": [
    null
  ],
  "Previous": [
    null
  ],
  "Results": [
    null
  ],
  "Total": [
    0
  ]
}
Array of object

List of fetched KeyDh Supply Interruption Connections

object

KeyDh Supply Interruption Connection object. Full version for list and detail methods.

attachedObjectId
integer

ID of the attached object. This is the ID of the object connected to the supply interruption. It should be a valid ID based on the attached object type.

id
integer

Primary key

isValveToClose
boolean

Indicates if the connection is a valve to close.

attachedObjectType
object (ObjectType)
id
integer

Primary key

identifier
string

Object type readable identifier

instanceAPIUrl
string (url)

Object type instances API endpoint URL.

name
string

Object type translated name. Not searchable.

interruption
object (KeyDhSupplyInterruption)

KeyDh Supply Interruption object. Full version for list methods.

actualEndDate
string (datetime)

Actual end date of supply interruption. Should not be before the actualStartDate.

actualStartDate
string (datetime)

Actual start date of supply interruption. Should not be after the actualEndDate.

description
string

Description of supply interruption

estEndDate
string (datetime)

Estimated end date of supply interruption. Should not be before the estStartDate.

estStartDate
string (datetime)

Estimated start date of supply interruption. Should not be after the estEndDate.

fillingAmount
number (double)

Filling amount of supply interruption

id
integer

Primary key

identification
string

Supply interruption identification

inCharge
string

In charge of supply interruption. Must be a valid contact person. Can be name or phone or combination of both. Found valid contact person is automatically linked to supply interruption. Can also be a contact person ID.

ExampleJohn Doe 123456789
location
string (EWKT)

Location of supply interruption

newEndDate
string (datetime)

New end date of supply interruption. Should not be before the newStartDate.

newStartDate
string (datetime)

New start date of supply interruption. Should not be after the newEndDate.

planner
string

Planner of supply interruption. Must be a valid contact person. Can be name or phone or combination of both. Found valid contact person is automatically linked to supply interruption. Can also be a contact person ID.

ExampleJohn Doe 123456789
Address
object (Address)
buildingId
string

Building id

city
string

Building city name

cityAlt
string

Building city name in alternative language

country
string

Building country

createdBy
string

creator

createdTs
string (date-time)

Creation date and time

district
string

Building district

id
integer

Primary key

location
string (ewkt)

Geographical location

municipality
string

Building municipality

propertyId
string

Property number

province
string

Building province

streetname
string

Building street name

streetnameAlt
string

Building street name in alternative language

streetno
string

Building number

subdivision
string

Building municipality subdivision

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

usagePurpose
object (BuildingUsage)

Building usage purpose

groupname

Group name of constant

Valid values[ "BUILDING_USAGE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

usagePurposeAlt
object (AddressSecondaryUsage)

Address usage purpose

groupname

Group name of constant

Valid values[ "KN_ADDR_SPEC" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

zipcode
string

Building zipcode

Plan
object (Plan)

Plan

Branch_line
object (DHCPDN)

District Heating Consumer Point Duct Diameter

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[ "DH_CP_DN" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

Center_measure
object (DHCPDN)

District Heating Consumer Point Duct Diameter

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[ "DH_CP_DN" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

Construction
object (PlanConstruction)

Plan Construction

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[ "PLAN_CONSTRUCTION" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

Excavation
object (PlanExcavation)

Plan Excavation

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[ "PLAN_EXCAVATION" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

Limiter
object (DHCPLimiter)

District Heating Consumer Point Limiter

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[ "DH_CP_LIMITER" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

Plan_piping
object (PlanPiping)

Plan Piping

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[ "PLAN_PIPING" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

agreed_delivery_date
string (date-time)

Agreed Delivery Date. Activated on request by customer.

area_description
string

Area Description. Activated on request by customer.

begin_date
string (date-time)

Begin Date

construction_year
integer

Contact Name. Not shown when displaying plan details in related objects. Activated on request by customer.

contact_email
string

Contact Email Address. Activated on request by customer.

contact_name
string

Contact Name. Activated on request by customer.

contact_phone
string

Contact phone number. Activated on request by customer.

cp_identification
string

Consumer Point Identification. Activated on request by customer.

created_by
string

Created by

created_date
string (date-time)

Create Date

customer_contact_date
string (date-time)

Customer Contact Date. Activated on request by customer.

description
string

Description

desired_delivery_date
string (date-time)

Desired Delivery Date. Activated on request by customer.

district_area
object (DistrictArea)

District Area

location
string (ewkt)

Geographical location as EWKT representation

name
string

Name of District Area

duration
integer

Duration. Activated on request by customer.

expire_date
string (date-time)

Expire Date

first_contact
string

First contact person for plan. Not shown when displaying plan details in related objects. Activated on request by customer.

id
integer

Unique id of plan

implementation_begin_end
string (date-time)

Implementation Date. Activated on request by customer.

implementation_date
string (date)

Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.

latest_implementation_date
string (date)

Latest Implementation Date. Activated on request by customer. Format is date with no time from product version 3.7.1.

list_url
string (url)

URL to the list of all Plans. Only shown when displaying plan details in related objects.

location
string (ewkt)

Geographical location. As EWKT representation

louhi_id
string

Louhi ID. Activated on request by customer.

modifications
string

Modifications. Not shown when displaying plan details in related objects. Activated on request by customer.

name
string

Name of Plan

network
object (PlanNetworkType)

Plan Network 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[ "PLAN_NETWORK_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

network_owner
object (PlanNetworkOwner)

Plan Network Owner

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[ "PLAN_NETWORK_OWNER" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

offer_accepted_date
string (date-time)

Offer Accepted Date. Activated on request by customer.

offer_id
string

Offer ID. Activated on request by customer.

parentplan
string (url)

URL to the plan of which the plan is part of (subplan). Available from version 3.2.24. Activated on request by customer.

plan_remark
string

Plan remark. Not shown when displaying plan details in related objects. Activated on request by customer.

plumbing_start_date
string (date-time)

Plumbing Start Date. Activated on request by customer.

property_address
string

Property address. Not shown when displaying plan details in related objects. Activated on request by customer.

publicity
object (PlanPublicity)

Plan Publicity

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[ "PLAN_PUBLICITY" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

state
object (PlanState)

Plan state

groupname

Group name of constant

Valid values[ "PLAN_STATE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

total_cost
number (float)

Sum of cost for all related objects for the plan. Not shown when displaying plan details in related objects. Activated on request by customer.

type
object (PlanType)

Plan type

groupname

Group name of constant

Valid values[ "PLAN_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants from this group

logical_txt
string

Logical textual value

txt
string

Human readable textual representation

updated_by
string

Updated by

updated_date
string (date-time)

Update Date

work_activities
string

Work Activities. Activated on request by customer.

work_phase
object (PlanWorkPhase)

Plan Work Phase

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[ "PLAN_WORK_PHASE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

work_project
string

Work Project. Activated on request by customer.

work_type
object (PlanWorkType)

Plan Work 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[ "PLAN_WORK_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

work_type_main
object (PlanWorkTypeMain)

Plan Work Type Main

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[ "PLAN_WORK_TYPE_MAIN" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

work_type_sub
object (PlanWorkTypeSub)

Plan Work Type Sub

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[ "PLAN_WORK_TYPE_SUB" ]
id
integer

Unique id of constant

list_url
string (url)

Url to fetch all constants 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

consumerPointCount
integer

Consumer point count for supply interruption.

ductVolume
number (double)

Duct volume for supply interruption. Calculated from connected objects.

job
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

networkType
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

power
number (double)

Power for supply interruption. Calculated from connected objects.

state
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

type
object (TxtConstant)
groupname
string

Group name of constant. Same as groupname parameter.

id
integer

Unique id of constant

logical_txt
string

Logical textual value

txt
string

Human readable textual representation (translated)

waterFlow
number (double)

Water flow for supply interruption. Calculated from connected objects.

401

Authentication credentials are missing or invalid

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

Detailed description of error