Update circuit section partially
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Update circuit section partially

  • Dark
    Light
  • PDF

Article summary

Patch
/sections/{id}/

Operation is used to update specific fields in existing circuit section. Available from product version 3.2.2.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of circuit section to update

Body parameters

Circuit section attributes and values to be updated

object
bitrate
integer

Circuit section bitrate id

circuit
string (url)

Circuit the section is in

connectionDate
string (date-time)

actual section connection date

constructionState
integer

Circuit section construction state id

disconnectionDate
string (date-time)

actual section disconnection date

id
integer

Primary key

name
string

Section name

plannedConnectionDate
string (date-time)

planned section connection date

plannedDisconnectionDate
string (date-time)

planned section disconnection date

usagePurpose
integer

Circuit section usage purpose id

usageState
integer

Circuit section usage state id

Responses
200

Object was updated successfully

object
bitrate
integer

Circuit section bitrate id

circuit
string (url)

Circuit the section is in

connectionDate
string (date-time)

actual section connection date

constructionState
integer

Circuit section construction state id

disconnectionDate
string (date-time)

actual section disconnection date

id
integer

Primary key

name
string

Section name

plannedConnectionDate
string (date-time)

planned section connection date

plannedDisconnectionDate
string (date-time)

planned section disconnection date

usagePurpose
integer

Circuit section usage purpose id

usageState
integer

Circuit section 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?