Update logical connection data partially
  • 28 Oct 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Update logical connection data partially

  • Dark
    Light
  • PDF

Article summary

Patch
/ccp-connections/{id}/

Operation is used to update specific fields in existing logical 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 logical connection to update

Body parameters

Logical connection attributes and values to be updated

object
attenuation
number (float)

Connection attenuation

cableLength
number (float)

Cable length

ccp1Id
integer Required

Cross connection point 1 id. Can not be used when patching an existing logical connection.

ccp2Id
integer Required

Cross connection point 2 id. Can not be used when patching an existing logical connection.

constState
integer

Construction state id

directionId
integer

Direction id

Responses
200

Object was updated successfully

object
attenuation
number (float)

Connection attenuation

cableLength
number (float)

Cable length

ccp1Id
integer

Cross connection point 1 id. Can not be used when patching an existing logical connection.

ccp1PremId
integer

Cross connection point 1 premises id

ccp1TermId
integer

Cross connection point 1 terminal id

ccp2Id
integer

Cross connection point 2 id. Can not be used when patching an existing logical connection.

ccp2PremId
integer

Cross connection point 2 premises id

ccp2TermId
integer

Cross connection point 2 terminal id

connectionType
integer

Connection type id

constState
integer

Construction state id

directionId
integer

Direction id

id
integer

Primary key

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?