Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Health Check: The link has been rewritten to its master page by check 'P16'.

...

Code Block
languagephp
http://DOMAIN/api/API_KEY/cable.OUTPUT

Insert excerpt
SQL API Calls
SQL API Calls
nopaneltrue

Available Fields

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 
Toggle cloak
Cloak

Insert excerpt
API
API
nopaneltrue



Status of the Cable Path.

typeyes*String

"type=PATHS" is Required to indicate that this will process a Cable Path record. This can be added as a POST parameter or within the URI as shown below.

...

Field

Required

Data Type

Options

Default

Notes

recid

yes*

Integer



The RECID of the Cable Path Leg. *Required only if attempting an UPDATE. RECID column from PATH_LEGS table.

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.

typeyes*String

"type=PATH_LEGS" is required to indicate that this is to process a Cable Path Leg record

...