Connect a cable to a cable
  • 28 Aug 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Connect a cable to a cable

  • Dark
    Light
  • PDF

Article summary

Post
/cables/connect_to_cable

Operation is used to connect a cable to a cable. Connections will be created automatically if necessary. Available from product version 3.6.3.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Body parameters

Cable to cable connection details

object
cable1
integer Required

Cable 1 ID

cable2
integer Required

Cable 2 ID

direction1
string Required

Which end of the cable1 to connect to

Valid values[ "B", "E", "T" ]
direction2
string Required

Which end of the cable2 to connect to

Valid values[ "B", "E", "T" ]
manhole
integer

Manhole ID

premise
integer

Telecom Premise ID

splice
integer

Splice ID

startThread1
integer Required

Starting thread to connect from cable1

startThread2
integer Required

Starting thread to connect from cable2

state
integer Required

Thread Connection Usage State ID

threadCount
integer Required

Number of threads to connect between cable1 and cable2

Responses
201

Connection creation confirmation

object

cable connected to cable

details
string

Detailed description

400

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

object

Fields which failed validation

property*
Array of string additionalProperties

List of validation errors for this fieldname

string

Validation error

409

Connection couldn't be created automatically. Either the cable or target object doesn't have a location or the chosen cable end is not the closest one to the target.

object

Connection errors

property*
Array of string additionalProperties

List of connection errors

string

Connection error


Was this article helpful?