Contents x
    Get list of Dh Cables
    • 17 Jan 2024
    • 8 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Get list of Dh Cables

    • Updated on 17 Jan 2024
    • 8 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Get
    /dh-cable/

    Operation is used to get a list of Dh Cables.

    Dh Cable data can be filtered by giving filtering parameters at HTTP querystring (see parameters).

    Security
    API Key
    Header parameter nameAuthorization

    Token issued for API consumer.

    Query parameters
    offset
    integer

    Offset to start returning results.

    Minimum0
    limit
    integer

    Limit number of results returned.

    Minimum1
    __any of the object fields__
    string

    Filters list by selected object field value. Supports structured queries via +__+ delimiter. Supports ending keywords via +__+ delimiter:

    • For string fields: istartswith, startswith, iendswith, endswith, contains, icontains, isnull
    • For numerics: gt, lt, gte, lte, isnull
    • For spatial fields: contains, isnull, within, intersects, disjoint, touches, overlaps, covers, coveredby Examples: +++usage_state__txt__istartswith=in+++ , +++plan__state__txt__startswith=In+++ , +++creation_date__gte=2019-01-02T15:32:01+++, +++location__within=POLYGON ((641503.89 6944059.81, 641406.52 6943933.87, 641369.48 6943772.48, 641474.25 6943704.74, 641873.78 6943735.96, 641848.38 6943975.15, 641607.08 6944167.76, 641653.11 6944102.15, 641503.89 6944059.81))+++
    orderby
    string

    Selects the object field to order the returned objects by. Can be used to sort in reverse order with '-' prefix. Can have several ordering rules separated by comma. Can be used only for object own fields and does not supports structured queries. Example: orderby=creator,-creation_date

    Responses
    200

    A result response object

    Expand All
    object
    Next
    string (url)

    Url to next page of the list if applicable. (Null if none)

    Prev
    string (url)

    Url to previous page of the list if applicable. (Null if none)

    Results
    Array of object (DhCable)

    List of fetched Dh Cables

    object
    CableType
    object (DhCableType)
    Technology
    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)

    def_installation
    string

    Def installation

    id
    integer

    Primary key

    specification
    string

    Specification

    technologyTxt
    string

    Technology

    type
    string

    Type

    voltage
    number (float)

    Voltage

    Contractor
    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)

    InstallationType
    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)

    Insulation_resistance_1_m_unit
    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)

    Insulation_resistance_1_p_unit
    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)

    Insulation_resistance_2_m_unit
    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)

    Insulation_resistance_2_p_unit
    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)

    Loop_manhole
    integer

    Loop manhole id

    Measure
    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)

    Measurement_manhole
    integer

    Measurement manhole id

    NetType
    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)

    Owner
    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)

    Plan
    object (Plan)

    Plan

    Branch_line
    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)

    Center_measure
    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)

    Construction
    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)

    Excavation
    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)

    Limiter
    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)

    Plan_piping
    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)

    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 (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)

    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 (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)

    network_owner
    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)

    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 (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)

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

    work_project
    string

    Work Project. Activated on request by customer.

    work_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)

    work_type_main
    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)

    work_type_sub
    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)

    Renter
    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)

    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)

    accuracy_id
    object (SnConstants)
    groupname
    string

    Group name of constant. Group name must contain only uppercase letters separated by underscores.

    id
    integer

    Primary key

    num_value
    integer

    Numerical value of the constant

    orderno
    integer

    Order number

    txt
    string

    Human readable textual representation

    txt_2
    string

    Human readable textual representation

    value
    string

    Logical textual value

    created_by
    string

    Created by

    created_ts
    string (date-time)

    Date created

    false_cable
    boolean

    If false cable or not

    h_accuracy
    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)

    history_date
    string (date)

    History date

    identification
    string

    Identification

    install_date
    string (date)

    Install date

    install_year
    integer

    Install year

    insul_resist_1_m
    string

    Insulation resistance

    insul_resist_1_p
    string

    Insulation resistance

    insul_resist_2_m
    string

    Insulation resistance

    insul_resist_2_p
    string

    Insulation resistance

    lbl_angle_exp
    string

    Export label angle

    lbl_color_exp
    string

    Export label color

    lbl_size_exp
    string

    Export size color

    length
    number (float)

    Length

    location
    string (ewkt)

    Geographical location

    location_accuracy
    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)

    loop_circuit
    string

    Loop circuit

    loop_notes_m
    string

    Loop notes

    loop_notes_p
    string

    Loop notes

    loop_resist_m
    string

    Loop resistance

    loop_resist_p
    string

    Loop resistance

    mapid
    integer

    Map id

    mapper
    string

    Mapper

    mapping_method_id
    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)

    measure_circuit
    string

    Measure circuit

    measure_notes_m
    string

    Measure notes

    measure_notes_p
    string

    Measure notes

    measure_voltage_m
    string

    Measurement voltage

    measure_voltage_m2
    string

    Measurement voltage

    measure_voltage_p
    string

    Measurement voltage

    measure_voltage_p2
    string

    Measurement voltage

    measurement_date
    string (date-time)

    Measurement date

    mslink
    integer

    Primary key

    note
    string

    Additional details

    pulse
    string

    Pulse

    survey_amount
    string

    Survey amount

    sym_angle_exp
    string

    Export symbol angle

    sym_code_gt
    string

    Symbol code

    sym_color_exp
    string

    Export symbol color

    sym_name_exp
    string

    Export symbol name

    sym_size_exp
    string

    Export symbol size

    sym_text_exp
    string

    Export symbol text

    sym_width_exp
    string

    Export symbol width

    t_area_id
    object (DhDivision)
    area_id
    object (DhArea)
    mslink
    integer

    Primary key

    name
    string

    Name

    created_by
    string

    Creator

    created_ts
    string (date-time)

    Date created

    location
    string (ewkt)

    Geographical location

    mslink
    integer

    Primary key

    name
    string

    Name

    remarks
    string

    Remarks

    updated_by
    string

    Updated by

    updated_ts
    string (date-time)

    Date updated

    updated_by
    string

    Updated by

    updated_ts
    string (date-time)

    Date updated

    Total
    integer

    Total number of Dh Cable objects in the list

    401

    Authentication credentials are missing or invalid

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

    Detailed description of error

    Was this article helpful?
    What's Next
    Products
    Company
    Our Mission
    Connect With Us
    Support
    Copyright © Keypro Oy. All Rights Reserved