Contents x
    Create new cable
    • 28 Aug 2024
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Contents

    Create new cable

    • Updated on 28 Aug 2024
    • 3 Minutes to read
    • Contributors
    • Print
    • Dark
      Light
    • PDF
    Article summary

    Post
    /cables/

    Operation is used to create new cable. Available from product version 3.2.6.

    Note: When creating cable with length, measure ID is required.

    Security
    API Key
    Header parameter nameAuthorization

    Token issued for API consumer.

    Body parameters

    cable to be created

    object
    automSecLengthCalc
    boolean

    Automatic secondary length calculation

    batch
    string

    Cable batch

    cableId
    string

    Cable ID

    cableType
    integer Required

    Cable type id

    endReading
    integer

    End reading

    falseCable
    boolean

    Is cable a false cable

    heightAccuracy
    integer

    Height accuracy id

    historyDate
    string (date-time)

    Mapping date

    identification
    string

    Identification. Checked based on Identification Uniqueness Rule

    importance
    integer

    Cable importance

    installYear
    integer

    Install year

    installationType
    integer Required

    Cable installation type id

    layingState
    integer

    Laying state id of the cable

    length
    number (float)

    Cable length. Writeable from 3.2.20.

    location
    string (ewkt)

    Geographical location

    locationAccuracy
    integer

    Location accuracy id

    mapper
    string

    Mapper

    mappingMethod
    integer

    Mapping method id

    measure
    integer

    Measure id

    owner
    integer

    Cable owner id

    plan
    integer

    Plan id

    rentPaid
    boolean

    Is rent paid

    renter
    integer

    Cable renter id

    role
    integer

    Cable role id

    safetyDistance
    integer

    Safety distance id. Available from product version 3.6.4.

    secondaryLength
    number (float)

    Secondary length

    startReading
    integer

    Start reading

    state
    integer Required

    Cable state id

    supercable
    integer

    supercable id

    supercableOrderNo
    integer

    Specifies supercable order

    surveyAmount
    integer

    Survey amount

    telecomArea
    integer

    Telecom area id

    Responses
    201

    A created Cable

    {
  "automSecLengthCalc": null,
  "batch": "",
  "cableId": "",
  "cableType": 26890,
  "connectedCapacity": null,
  "createdBy": "user@keypro.fi",
  "createdTs": "2020-02-19T12:41:35Z",
  "endReading": null,
  "extraLength": null,
  "falseCable": null,
  "freeCapacity": null,
  "heightAccuracy": null,
  "historyDate": null,
  "id": 4619570,
  "identification": "Test cable",
  "importance": null,
  "installYear": 1999,
  "installationType": 3230,
  "length": null,
  "location": "LINESTRING Z (453950.3968999999924563 6702355.8256999999284744 0.0000000000000000, 453906.3121999999857508 6702314.9418999999761581 0.0000000000000000, 453882.1871999999857508 6702293.8472999995574355 0.0000000000000000, 453840.5094999999855645 6702261.6430000001564622 0.0000000000000000, 453799.4174999999813735 6702227.8823999995365739 0.0000000000000000, 453759.3870999999926426 6702197.4374000001698732 0.0000000000000000, 453721.3789000000106171 6702164.1966000003740191 0.0000000000000000, 453681.9722000000183471 6702132.7240000003948808 0.0000000000000000, 453650.0884000000078231 6702108.3876000000163913 0.0000000000000000, 453614.8120999999810010 6702079.4940999997779727 0.0000000000000000, 453581.6897999999928288 6702053.2345000002533197 0.0000000000000000, 453554.9898999999859370 6702024.1650000000372529 0.0000000000000000, 453519.5375999999814667 6701999.7505999999120831 0.0000000000000000, 453478.0347000000183471 6701972.6952999997884035 0.0000000000000000, 453443.6049999999813735 6701951.0467999996617436 0.0000000000000000, 453400.0459000000264496 6701926.4113999996334314 0.0000000000000000, 453372.2803999999887310 6701907.8296999996528029 0.0000000000000000, 453334.5289999999804422 6701883.0614999998360872 0.0000000000000000, 453282.7420000000274740 6701892.8850999996066093 0.0000000000000000, 453214.3585999999777414 6701906.2022000001743436 0.0000000000000000, 453163.1503999999840744 6701916.6575999995693564 0.0000000000000000, 453156.6243000000249594 6701883.6019000001251698 0.0000000000000000)",
  "locationAccuracy": null,
  "mapper": "Test user",
  "mappingMethod": null,
  "measure": 9221,
  "owner": null,
  "plan": null,
  "remarks": "This is a test cable.",
  "rentPaid": null,
  "renter": null,
  "role": null,
  "secondaryLength": null,
  "startReading": null,
  "state": 3210,
  "supercable": null,
  "supercableOrderno": null,
  "surveyAmount": "",
  "telecomArea": null,
  "totalCapacity": null,
  "totalLength": null,
  "updatedBy": "user@keypro.fi",
  "updatedTs": "2020-02-19T12:41:35Z",
  "usedCapacity": null
}
    object
    automSecLengthCalc
    boolean

    Automatic secondary length calculation

    batch
    string

    Cable batch

    cableId
    string

    Cable ID

    cableType
    integer

    Cable type id

    connectedCapacity
    integer

    Connected capacity. This field can not be used for filtering results in searches. Available from product version 3.2.12.

    createdBy
    string

    Creator

    createdTs
    string (date-time)

    Creation date time

    endReading
    integer

    End reading

    extraLength
    number (float)

    Extra length

    falseCable
    boolean

    Is cable a false cable

    freeCapacity
    integer

    Free capacity. This field can not be used for filtering results in searches. Available from product version 3.2.12.

    heightAccuracy
    integer

    Height accuracy id

    historyDate
    string (date-time)

    Mapping date

    id
    integer

    Primary key

    identification
    string

    Identification. Checked based on Identification Uniqueness Rule

    importance
    integer

    Cable importance

    installYear
    integer

    Install year

    installationType
    integer

    Cable installation type id

    layingState
    integer

    Laying state id of the cable

    length
    number (float)

    Cable length. Writeable from 3.2.20.

    location
    string (ewkt)

    Geographical location

    locationAccuracy
    integer

    Location accuracy id

    mapper
    string

    Mapper

    mappingMethod
    integer

    Mapping method id

    measure
    integer

    Measure id

    owner
    integer

    Cable owner id

    plan
    integer

    Plan id

    rentPaid
    boolean

    Is rent paid

    renter
    integer

    Cable renter id

    role
    integer

    Cable role id

    safetyDistance
    integer

    Safety distance id. Available from product version 3.6.4.

    secondaryLength
    number (float)

    Secondary length

    startReading
    integer

    Start reading

    state
    integer

    Cable state id

    supercable
    integer

    supercable id

    supercableOrderNo
    integer

    Specifies supercable order

    surveyAmount
    integer

    Survey amount

    telecomArea
    integer

    Telecom area id

    totalCapacity
    integer

    Total capacity

    totalLength
    number (float)

    Total length

    updatedBy
    string

    Last updater

    updatedTs
    string (date-time)

    Last update date time

    usedCapacity
    integer

    Used capacity. This field can not be used for filtering results in searches. Available from product version 3.2.12.

    400

    There was an error in request. Usually field validation failed.

    object

    Fields which failed validation

    property*
    Array of string additionalProperties

    List of validation errors for this fieldname

    string

    Validation error

    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