Create new telecom duct

28 Oct 2024
1 Minute to read
Contributors

Print
Dark
Light
PDF

Create new telecom duct

Updated on 28 Oct 2024
1 Minute to read
Contributors

Print
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Post

/ducts/

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

Security

API Key

Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Telecom Duct to be created

object

cables

Array of string

Telecom Cables in the duct

string (url)

colour

integer

colour id

conduit

Array of integer Required

Telecom Conduit the duct is in

integer (id)

ductType

integer Required

duct type id

hole

boolean

Telecom Duct hole

identification

string

Telecom Duct identification

installYear

integer

Telecom Duct installation year

owner

integer

owner id

parent

integer

parent duct id

plan

integer

Plan id

remarks

string

remarks for Telecom Duct

rentPaid

boolean

Was rent paid for Telecom Duct

renter

integer

renter id

sourceKey

integer

Source system key. Available from product version 3.2.12.

sourceSystem

integer

Available from product version 3.2.12.

subductsNo

integer

Telecom Duct subducts number

usageState

integer Required

usage state id

Responses

201

A created Telecom Duct

{
  "cables": [],
  "colour": null,
  "conduit": [],
  "created_by": "api@keypro.fi",
  "created_ts": "2019-11-27",
  "ductType": 841,
  "hole": null,
  "id": 1769510,
  "identification": "",
  "installYear": null,
  "owner": null,
  "parent": null,
  "plan": null,
  "remarks": "",
  "rentPaid": null,
  "renter": null,
  "subductsNo": null,
  "updated_by": "api@keypro.fi",
  "updated_ts": "2019-11-27",
  "usageState": 1120
}

object

cables

Array of string

Telecom Cables in the duct

string (url)

colour

integer

colour id

conduit

Array of integer

Telecom Conduit the duct is in

integer (id)

created_by

string

Created by. Available from product version 3.2.24.

created_ts

string (date-time)

Created timestamp. Available from product version 3.2.24.

ductType

integer

duct type id

hole

boolean

Telecom Duct hole

integer

Primary key

identification

string

Telecom Duct identification

installYear

integer

Telecom Duct installation year

owner

integer

owner id

parent

integer

parent duct id

plan

integer

Plan id

remarks

string

remarks for Telecom Duct

rentPaid

boolean

Was rent paid for Telecom Duct

renter

integer

renter id

sourceKey

integer

Source system key. Available from product version 3.2.12.

sourceSystem

integer

Available from product version 3.2.12.

subductsNo

integer

Telecom Duct subducts number

updated_by

string

Last updated by. Available from product version 3.2.24.

updated_ts

string (date-time)

Last updated timestamp. Available from product version 3.2.24.

usageState

integer

usage state id

400

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

{
  "conduit": [
    "This field is required."
  ],
  "ductType": [
    "This field is required."
  ],
  "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

Delete telecom duct