Update telecom duct partially
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Update telecom duct partially

  • Dark
    Light
  • PDF

Article summary

Patch
/ducts/{id}

Operation is used to update specific fields in existing telecom duct. Available from 3.2.12 product version.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of telecom duct to update

Body parameters

Telecom Duct attributes and values to be updated

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
200

Object was updated successfully

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

id
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

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?