...
Below is the proper format for making a separate request.
Note: "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.
Cable Paths End point
Code Block | ||
---|---|---|
| ||
http://DOMAIN/api/API_KEY/cable.OUTPUT |
Insert excerpt SQL API Calls SQL API Calls nopanel true
Insert excerpt Custom API Custom API nopanel true
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 |
| Status of the Cable Path. | |||||||||||||
type | yes* | 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. |
Sample Request
Call:
Code Block | ||
---|---|---|
| ||
POST DOMAIN/KEY/cable.json |
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
If the request is successful, the RECID of the Cable Path is returned as follows:
|
Cable Path Legs
Cable Path Legs can be easily updated or added. If multiple Cable Path Legs need to be added or updated, then separate POST requests will need to be made for each Path Leg.
Below is the proper format for making a separate request.
Note: "type=PATH_LEGS" is required to indicate that this is to process a Cable Path Leg record. This can be added as POST parameter or within the URI as shown below.
Cable Path Legs End point
...
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. | ||
type | yes* | String | "type=PATH_LEGS" is required to indicate that this is to process a Cable Path Leg record |
...
Cloak | |||||||
---|---|---|---|---|---|---|---|
If the request is successful, the RECID of the Cable Path Leg is returned as follows:
|
Locating Cable Data
Within PCR-360, these menu options lists a variety of Grids that can be used to help locate any of the required fields.
...