Get telecom conduit details
  • 28 Oct 2024
  • 13 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Get telecom conduit details

  • Dark
    Light
  • PDF

Article summary

Get
/conduits/{id}

Operation is used to retrieve full details of given telecom conduit id. Available from 3.2.10 product version.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of telecom conduit

Responses
200

Telecom Conduit

Expand All
object
autoSecondaryLength
boolean

automatically generate secondaryLength. Subject to separate order.

cables
Array of string

Telecom Cables in the conduit

string (url)
categoryId
integer

Telecom Conduit category Id

conduitType
object (ElConduitType)

Electrical and telecom conduit 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[ "CONDUIT_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

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

createdBy
string

creator

createdTs
string (date-time)

Creation date and time

ductCount
integer

Telecom Conduit duct count

ducts
Array of string

Telecom Ducts in the conduit

string (url)
heightAccuracy
object (HeightAccuracy)

Height accuracy

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

Unique id of constant

list_url
string (url)

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

id
integer

Primary key

identification
string

Identification

length
number (float)

Telecom Conduit length

location
string (ewkt)

Geographical location

locationAccuracy
object (LocationAccuracy)

Location accuracy

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

Unique id of constant

list_url
string (url)

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

mapper
string

mapper name

mappingDate
string (date-time)

mapping date

mappingMethod
object (MappingMethod)

Mapping method

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

Unique id of constant

list_url
string (url)

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

measure
object (CableMeasure)

Cable or conduit measure

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

Unique id of constant

list_url
string (url)

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

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

Unique id of constant

list_url
string (url)

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

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

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

Unique id of constant

list_url
string (url)

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

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 contants 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 contants 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 contants 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 contants 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

profileStatus
object (ElConduitProfileStatus)

Electrical and telecom conduit profile status

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

Unique id of constant

list_url
string (url)

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

remarks
string

remarks on the Telecom conduit

safetyDistance
object (SafetyDistance)

Safety Distance

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

Unique id of constant

list_url
string (url)

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

secondaryLength
number (float)

Conduit secondary length. Subject to separate order.

sourceKey
integer

Telecom Conduit external source key. Available from product version 3.2.12.

sourceSystem
object (SourceSystem)

External source system

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

Unique id of constant

list_url
string (url)

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

surfaceType
object (SurfaceType)

Type of ground surface a conduit is buried in. Available from product version 3.2.24.

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

Unique id of constant

list_url
string (url)

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

surveyAmount
integer

unknown

telecomArea
object (TelecomArea)

Telecom Area

areaSize
number (float)

Area size

createdBy
string

Creator

createdTs
string (date-time)

Creation date time

exchangeArea
object (ExchangeArea)

Exchange Area

id
integer

Primary key

name
string

Area name

id
integer

Primary key

location
string (ewkt)

Geographical location

name
string

Area name

perimeter
number (float)

Area perimeter length

remarks
string

Area comments

telecomAreaType
object (TelecomAreaType)

Telecom area 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[ "TELECOM_AREA_TYPE" ]
id
integer

Unique id of constant

list_url
string (url)

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

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

usageState
object (ElConduitUsageState)

Electrical and telecom conduit usage state

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

Unique id of constant

list_url
string (url)

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

width
number (float)

Telecom Conduit width

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?