Create new telecom conduit
  • 28 Oct 2024
  • 2 Minutes to read
  • Contributors
  • Dark
    Light
  • PDF

Create new telecom conduit

  • Dark
    Light
  • PDF

Article summary

Post
/conduits/

Operation is used to create telecom conduit. Available from 3.2.12 product version.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Telecom Conduit to be created

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
integer

conduit type id

ductCount
integer

Telecom Conduit duct count

ducts
Array of string

telecom Ducts in the conduit

string (url)
heightAccuracy
integer

height accuracy id

identification
string

Identification

length
number (float)

Telecom Conduit length

location
string (ewkt)

Geographical location

locationAccuracy
integer

location accuracy id

mapper
string

mapper name

mappingDate
string (date-time)

mapping date

mappingMethod
integer

mapping method id

measure
integer

measure id

plan
integer

Plan id

profileStatus
integer

profile status id

remarks
string

remarks on the Telecom conduit

safetyDistance
integer

Safety distance id. Available from product version 3.6.4.

secondaryLength
number (float)

Conduit secondary length. Subject to separate order.

surfaceType
integer

surface type id. Available from product version 3.2.24.

surveyAmount
integer

unknown

telecomArea
integer

telecom area id

usageState
integer Required

usage state id. Will be set to a default value when not given.

width
number (float)

Telecom Conduit width

Responses
201

A created Telecom Conduit

{
  "cables": [],
  "categoryId": null,
  "conduitType": null,
  "createdBy": "user@keypro.fi",
  "createdTs": "2020-11-06T12:50:09Z",
  "ductCount": null,
  "ducts": [],
  "heightAccuracy": null,
  "id": 3106150,
  "identification": "",
  "length": null,
  "location": null,
  "locationAccuracy": null,
  "mapper": "",
  "mappingDate": null,
  "mappingMethod": null,
  "measure": 9221,
  "plan": null,
  "profileStatus": null,
  "remarks": "",
  "surveyAmount": "",
  "telecomArea": null,
  "updatedBy": "user@keypro.fi",
  "updatedTs": "2020-11-06T12:50:09Z",
  "usageState": null,
  "width": null
}
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
integer

conduit type id

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
integer

height accuracy id

id
integer

Primary key

identification
string

Identification

length
number (float)

Telecom Conduit length

location
string (ewkt)

Geographical location

locationAccuracy
integer

location accuracy id

mapper
string

mapper name

mappingDate
string (date-time)

mapping date

mappingMethod
integer

mapping method id

measure
integer

measure id

plan
integer

Plan id

profileStatus
integer

profile status id

remarks
string

remarks on the Telecom conduit

safetyDistance
integer

Safety distance id. Available from product version 3.6.4.

secondaryLength
number (float)

Conduit secondary length. Subject to separate order.

surfaceType
integer

surface type id. Available from product version 3.2.24.

surveyAmount
integer

unknown

telecomArea
integer

telecom area id

updatedBy
string

Last updater

updatedTs
string (date-time)

Last update date time

usageState
integer

usage state id. Will be set to a default value when not given.

width
number (float)

Telecom Conduit width

400

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

{
  "usageState": [
    "This field is required."
  ]
}
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