Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Field

Required

Data Type

Options

Default

Notes

recid

yes*

Integer



The RECID of the Cable Path. *Required only if attempting an UPDATE.

service

yes*

Integer



RECID of the Service to assign to the Cable Path. *Either a Service OR Location is required, but not both.

location

yes*

Integer



RECID of the Location to assign to the Cable Path. *Either a Service OR Location is required, but not both.

status

yes

Integer

Lists


Status of the Cable Path.

typeyesInteger

Type of Cable Path

Sample Request

Call:
Code Block
languagephp
POST DOMAIN/KEY/cable.json

...

Field

Required

Data Type

Options

Default

Notes

recid

yes*

Integer



The RECID of the Cable Path Leg. *Required only if attempting an UPDATE.

from_equipment

no

Integer



RECID of the Equipment that the Path Leg is coming from.

from_ppl

no

Integer



RECID of the Port/Pin/Len that the Path Leg is coming from.

cable

no

Integer



RECID of the Cable that the Path Leg is associated with.

pair_strand

yes*

Integer



Recid of the Pair/Strand that the Path Leg belongs to. *Required if Cable is provided.

to_equipment

no

Integer



RECID of the Equipment that the Path Leg ends at.

to_ppl

no

Integer



RECID of the Port/Pin/Len that the Path Leg ends at.

instance

yes

Integer



Instance number of the Path Leg.

path

yes

Integer



RECID of the Path that the Path Leg belongs on.

backbone_service

no

Integer



RECID of the Backbone Service.

location

yes*

Integer



RECID of the Location of the Path Leg. *Required if the Service that this Path Leg's belongs to is multi-location Service.

typeyesInteger

Type of Cable Path Leg
Sample Request

Call:

Code Block
POST DOMAIN/KEY/cable.json

...