Update circuit connection data partially
  • 28 Aug 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Update circuit connection data partially

  • Dark
    Light
  • PDF

Article summary

Patch
/circuit-connections/{id}/

Operation is used to update specific fields in existing circuit connection data. Available from product version 3.4.0.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of circuit connection to update

Body parameters

Circuit connection attributes and values to be updated

object
ccp
integer

Cross connection point id

connection
integer

Cross connection point connection id

details
string

Circuit connection details in text

order
integer

The order number in section's circuit connections

section
integer Required

Circuit section id

Responses
200

Object was updated successfully

object
address
integer

Address id

ccp
integer

Cross connection point id

circuit
integer

Circuit id

connection
integer

Cross connection point connection id

details
string

Circuit connection details in text

device
integer

Device id

hierarchy
integer

Circuit hierarchy id

id
integer

Primary key

order
integer

The order number in section's circuit connections

premises
integer

Telecom premises id

section
integer

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