Get electric cable details
- 29 Aug 2023
- 15 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Get electric cable details
- Updated on 29 Aug 2023
- 15 Minutes to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/el_cables/{id}/
Operation is used to retrieve full details of given electric cable id. Available from product version 3.2.2.
Security
API Key
Header parameter nameAuthorization
Token issued for API consumer.
Path parameters
id
integer Required
Id of electric cable
Responses
200
Electric cable
object
contractor
object
Electrical cable contractor
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["EL_CABLE_CONTRACTOR"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
creation_date
string
Creation date and time
creator
string
creator
depth_class
object
Electrical cable or conduit installation depth class
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["INSTALL_DEPTH_CLASS"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
false_cable
boolean
unknown
height_accuracy
object
Height accuracy
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["H_ACCURACY"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
id
integer
Primary key
identification
string
Identification
installation_date
string
installation date
installation_type
object
Electrical cable default installation type
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["CABLE_TYPE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
installation_year
integer
Installation year
length
number
cable length
location
string
Geographical location
location_accuracy
object
Location accuracy
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["LOCATION_ACCURACY"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
mapper
string
mapper name
mapping_date
string
mapping date
mapping_method
object
Mapping method
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["MAPPING_METHOD"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
measure
object
Electrical cable or conduit measure
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["CABLE_MEASURE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
network_area
object
Division
id
integer
Unique id of division
list_url
string
Url to fetch all divisions
location
string
Location of Division
name
string
Name of division
owner
object
Electrical cable owner
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["CABLE_OWNER"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
plan
object
Plan
Branch_line
object
District Heating Consumer Point Duct Diameter
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
Center_measure
object
District Heating Consumer Point Duct Diameter
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
Construction
object
Plan Construction
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
Excavation
object
Plan Excavation
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
Limiter
object
District Heating Consumer Point Limiter
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
Plan_piping
object
Plan Piping
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
agreed_delivery_date
string
Agreed Delivery Date. Activated on request by customer.
area_description
string
Area Description. Activated on request by customer.
begin_date
string
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
Create Date
customer_contact_date
string
Customer Contact Date. Activated on request by customer.
description
string
Description
desired_delivery_date
string
Desired Delivery Date. Activated on request by customer.
district_area
object
District Area
location
string
Geographical location as EWKT representation
name
string
Name of District Area
duration
integer
Duration. Activated on request by customer.
expire_date
string
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
Implementation Date. Activated on request by customer.
implementation_date
string
Implementation Date. Activated on request by customer.
latest_implementation_date
string
Latest Implementation Date. Activated on request by customer.
list_url
string
URL to the list of all Plans. Only shown when displaying plan details in related objects.
location
string
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
Plan Network Type
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
network_owner
object
Plan Network Owner
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
offer_accepted_date
string
Offer Accepted Date. Activated on request by customer.
offer_id
string
Offer ID. Activated on request by customer.
parentplan
string
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
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
Plan Publicity
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
state
object
Plan state
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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_STATE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
total_cost
number
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
Plan type
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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_TYPE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
updated_by
string
Updated by
updated_date
string
Update Date
work_activities
string
Work Activities. Activated on request by customer.
work_phase
object
Plan Work Phase
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
work_project
string
Work Project. Activated on request by customer.
work_type
object
Plan Work Type
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
work_type_main
object
Plan Work Type Main
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
work_type_sub
object
Plan Work Type Sub
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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 to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
remarks
string
Remarks. Available from product version 3.2.14.
renter
object
Electrical cable renter
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["CABLE_RENTER"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
safety_distance
object
Safety Distance
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["SAFETY_DISTANCE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
survey_amount
integer
unknown
type
object
Electrical cable type
R_L
number
Resistance L [ohm/km]
R_N
number
Resistance N [ohm/km]
X_L
number
Reactance L [ohm/km]
X_LN
number
Reactance LN [ohm/km]
X_N
number
Reactance N [ohm/km]
cable_technology
object
Electrical cable technology
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["EL_CABLE_TECHNOLOGY"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
conductor_material
object
Electrical cable default installation type
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["CABLE_TYPE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
id
integer
Primary key
installation_type
object
Electrical cable default installation type
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["CABLE_TYPE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
list_url
string
Url to fetch all cable types
specification
string
cable type specification
tech_name
string
cable tech name
temperature
number
Values measurement temperature, Celcius Degrees
type_name
string
cable type name
voltage
number
cable type voltage, V
update_date
string
Last update date time
updated_by
string
Last updater
usage_state
object
Electrical cable usage state
availability_end_ts
string
Ending date time for availability
availability_start_ts
string
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["CABLE_STATE"]
id
integer
Unique id of constant
list_url
string
Url to fetch all contants from this group
logical_txt
string
Logical textual value
num_value
number
Numeric value
num_value2
number
Numeric value 2
num_value3
number
Numeric value 3
num_value4
number
Numeric value 4
txt
string
Human readable textual representation
401
Authentication credentials are missing or invalid
{
"details": "Authentication credentials were not provided"
}object
details
string
Detailed description of error
404
Object was not found
{
"details": "Not found."
}object
details
string
Detailed description of error
Was this article helpful?
