Operation
post /data/otn/darkfiber/associate/phylinks
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | PFDLAssoc | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/darkfibers/associate/phylinks
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | PFDLAssoc | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/darkfiber
Query parameters
Name |
IsRequired |
Description |
---|---|---|
darkfiberdata | required | --- |
spooldata | optional | --- |
Form parameters
Name |
Description |
---|---|
afilelist (optional) | afilelistdefault: |
zfilelist (optional) | zfilelistdefault: |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
multipart/form-data
Example Request Data
Create API for dark fiber is a multipart/form data post operation. Following are the expected keys and values in the request Key : darkfiberdata Type : text Value : {"userLabel":"DarkFiberTest","aNode":"PSS32_10_41_51_248","zNode":"PSS32_10_41_51_249","aPort":"APORT","zPort":"ZPORT","aOtdrPort":"OTDR-14-7-P2","zOtdrPort":"OTDR-10-8-P1","aFiberType":"DSF","aFiberLength":"123","zFiberType":"LS","zFiberLength":"234","operator":"alcatel","modifiedOpertor":"alcatel","useOpertion":"Association"} Key : spooldata Type : text Value : {"aSpoolAZ":"10","zSpoolAZ":"14","aSpoolZA":"2","zSpoolZA":"2"} Key : afilelist Type : file Value : The AZ KML file to be uploaded Key : zfilelist Type : file Value : The ZA KML file to be uploaded
Produces
application/json;charset=UTF-8
application/json
Example Response Data
{ "message":"Dark fiber service created successfully.", "status":"Success", "identifier":"1" }
External Docs
Operation
post /data/otn/darkfibers
Query parameters
Name |
IsRequired |
Description |
---|---|---|
darkfiberdata | required | --- |
spooldata | optional | --- |
Form parameters
Name |
Description |
---|---|
afilelist (optional) | afilelistdefault: |
zfilelist (optional) | zfilelistdefault: |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
multipart/form-data
Produces
application/json;charset=UTF-8
application/json
External Docs
Operation
delete /data/otn/darkfiber
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | darkFiberIds | array[Integer] |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Example Request Data
[ 61, 62, 65 ]
Produces
application/json
Example Response Data
{ "message": "Delete initiated for dark fiber links 75,76 Please check the jobs page for more details", "status": "success", "identifier": "1" }
External Docs
Operation
delete /data/otn/darkfibers
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | darkFiberIds | array[Integer] |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberResponse
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
delete /data/otn/darkfiber/gis/deleteFiberAssoc/{dfID}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfID | required | dfID | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
delete /data/otn/darkfibers/gis/deleteFiberAssoc/{dfID}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfID | required | dfID | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
String
|
401Unauthorized | --- |
204No Content | --- |
403Forbidden | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/darkfiber/disassociate/phylinks
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | phyLinkIds | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberList
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /data/otn/darkfibers/disassociate/phylinks
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | phyLinkIds | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberList
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /data/otn/darkfiber/{id}/darkfiberList
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberList
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Example Response Data
{ "identifier": "1", "items": [ { "id": 2, "userLabel": "Abihek-Test-DarkFiberTest3", "aNode": "PSS32_10_41_51_248", "zNode": "PSS32-41.89.25", "aPort": "PSS8-41.89.22/SFD--4-EXP", "zPort": "PSS8-41.89.21/SFD--1-EXP", "aOtdrPort": "S8-4.89.175/SFD-2-3-EXP", "zOtdrPort": null, "aFiberType": "DSF", "zFiberType": "DSF", "aFiberLength": "500", "zFiberLength": "500", "createdDate": 1560151483230, "modifyDate": 1560151483230, "operator": "alcatel", "modifiedOpertor": "alcatel", "otdrPortState": "1000", "sourceNeId": 1, "destNeId": 4321, "key": "darkfiber/2" } ], "status": "Success", "message": "Successfully retrieved associated dark fiber." }
External Docs
Operation
get /data/otn/darkfibers/{id}/darkfiberList
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberList
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/darkfiber/{id}/physicalConns
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
action | required | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ResponseDtModel
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/darkfibers/{id}/physicalConns
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
action | required | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ResponseDtModel
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/darkfiber
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberList
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Example Response Data
{ "dflist": [ { "id": 68, "userLabel": "DarkFiber1", "aNode": "PSS32-41.89.22", "zNode": "PSS32-41.89.21", "aPort": "PSS8-41.89.22/SFD-1-3-EXP", "zPort": "PSS8-41.89.21/SFD-1-3-EXP", "aOtdrPort": "PSS8-41.89.175/SFD-1-3-EXP", "zOtdrPort": "PSS8-41.89.176/SFD-1-3-EXP", "aFiberType": "DSF", "zFiberType": "DSF", "aFiberLength": "500", "zFiberLength": "500", "createdDate": 1557291047021, "modifyDate": 1557291047021, "operator": "alcatel", "key": "darkfiber/68" }, { "id": 69, "userLabel": "DarkFiber2", "aNode": "PSS32-41.89.222", "zNode": "PSS32-41.89.221", "aPort": "PSS8-41.89.222/SFD-1-3-EXP", "zPort": "PSS8-41.89.221/SFD-1-3-EXP", "aOtdrPort": "PSS8-41.89.375/SFD-1-3-EXP", "zOtdrPort": "PSS8-41.89.376/SFD-1-3-EXP", "aFiberType": "DSF", "zFiberType": "DSF", "aFiberLength": "500", "zFiberLength": "500", "createdDate": 1557291047197, "modifyDate": 1557291047197, "operator": "alcatel", "key": "darkfiber/69" }, { "id": 70, "userLabel": "DarkFiber3", "aNode": "PSS32-41.89.22", "zNode": "PSS32-41.89.21", "aPort": "SS8-41.89.22/SFD-1-3-EXP", "zPort": "PSS8-41.89.21/SFD-1-3-EXP", "aOtdrPort": "PSS8-41.89.175/SFD-1-3-E", "zOtdrPort": "PSS8-41.89.176/SFD-1-3-EXP", "aFiberType": "ELEAF", "zFiberType": "ELEAF", "aFiberLength": "120", "zFiberLength": "150", "createdDate": 1557291047367, "modifyDate": 1557291047367, "operator": "alcatel", "key": "darkfiber/70" } ], "message": "Darkfiber details retrieved successfully", "status": "Succcess", "identifier": "1" }
External Docs
Operation
get /data/otn/darkfibers
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberList
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/darkfiber/{id}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ResponseDtModel«object»
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/darkfibers/{id}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ResponseDtModel«object»
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /data/otn/darkfiber/scanresult/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a dark fiber 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrScanResultResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Example Response Data
[ { "lastScanTime": 1562331600546, "userEnteredLength": null, "sourceNE": "PSS32_10_41_51_249", "baselineFilename": "otdrscan-171-aztx-bl.sor", "darkFiberId": 171, "lastScanLength": 116.6, "srcPort": "Port1", "fiberCutStatus": 0, "sourceNeId": 25, "destNE": "PSS32_10_41_51_248", "baselineTime": 1562331600546, "destPort": "Port123", "portDirection": "TX", "id": 1, "destNeId": 23, "lastScanFilename": "otdrscan-171-aztx-bl.sor", "baselineFiberLength": 116.6, "phyLinkId": 171, "span": "AZ", "triggeredBy": "Scheduler" }, { "lastScanTime": 1562331600546, "userEnteredLength": null, "sourceNE": "PSS32_10_41_51_249", "baselineFilename": "otdrscan-171-zatx-bl.sor", "darkFiberId": 171, "lastScanLength": 115.14, "srcPort": "Port123", "fiberCutStatus": 0, "sourceNeId": 23, "destNE": "PSS32_10_41_51_248", "baselineTime": 1562331600546, "destPort": "Port1", "portDirection": "TX", "id": 2, "destNeId": 25, "lastScanFilename": "otdrscan-171-zatx-bl.sor", "baselineFiberLength": 115.14, "phyLinkId": 171, "span": "ZA", "triggeredBy": "Scheduler" } ]
Operation
get /data/otn/darkfibers/scanresult/{dfId}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
dfId | required | 'dfId' is the unique id for a dark fiber 'id' from the REST call '/data/otn/darkfiber/list' | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
OtdrScanResultResponse
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Operation
post /data/otn/darkfiber/{id}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
darkfiberdata | required | --- |
spooldata | optional | --- |
Form parameters
Name |
Description |
---|---|
afilelist (optional) | afilelistdefault: |
zfilelist (optional) | zfilelistdefault: |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
multipart/form-data
Produces
application/json
External Docs
Operation
post /data/otn/darkfibers/{id}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
id | required | id | --- |
Query parameters
Name |
IsRequired |
Description |
---|---|---|
darkfiberdata | required | --- |
spooldata | optional | --- |
Form parameters
Name |
Description |
---|---|
afilelist (optional) | afilelistdefault: |
zfilelist (optional) | zfilelistdefault: |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DarkFiberResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
multipart/form-data
Produces
application/json
External Docs
Calendar
Name |
Type |
Description |
Enum |
---|---|---|---|
time | Date DateTime |
--- | --- |
lenient | Boolean boolean |
--- | --- |
firstDayOfWeek | Integer integer |
--- | --- |
minimalDaysInFirstWeek | Integer integer |
--- | --- |
timeZone | TimeZone TimeZone |
--- | --- |
timeInMillis | Long long |
--- | --- |
calendarType | String string |
--- | --- |
weekDateSupported | Boolean boolean |
--- | --- |
weekYear | Integer integer |
--- | --- |
weeksInWeekYear | Integer integer |
--- | --- |
DarkFiber
Name |
Type |
Description |
Enum |
---|---|---|---|
id | Integer integer |
--- | --- |
userLabel | String string |
--- | --- |
aNode | String string |
--- | --- |
zNode | String string |
--- | --- |
aPort | String string |
--- | --- |
zPort | String string |
--- | --- |
aOtdrPort | String string |
--- | --- |
zOtdrPort | String string |
--- | --- |
aFiberType | String string |
--- | --- |
zFiberType | String string |
--- | --- |
aFiberLength | String string |
--- | --- |
zFiberLength | String string |
--- | --- |
createdDate | Calendar Calendar |
--- | --- |
modifyDate | Date DateTime |
--- | --- |
operator | String string |
--- | --- |
modifiedOpertor | String string |
--- | --- |
otdrPortState | String string |
--- | --- |
sourceNeId | Integer integer |
--- | --- |
destNeId | Integer integer |
--- | --- |
key | String string |
--- | --- |
MultipartFile
Name |
Type |
Description |
Enum |
---|
OtdrScanResultResponse
Name |
Type |
Description |
Enum |
---|---|---|---|
srcPort | String string |
Source port where otdr scan is triggered | --- |
sourceNeId | String string |
Source NE Id where otdr scan is triggered | --- |
fiberCutStatus | String string |
Specifies difference between baseline and last scan fiberlength values. Note: This includes OTDR tolerance factor while computing fuber cut. | --- |
baselineFilename | String string |
Otdr baseline scan result file name. Prefix filename with https:// |
--- |
triggeredBy | String string |
Specifies how otdr scan was triggered - Manual/Scheduled/Auto. Manual means otdr scan triggered by operator using otdr scanNow option. Scheduled means otdr scan triggered by operator using otdr schedule option. Auto means otdr scan initiated by notification from Node. | --- |
sourceNE | String string |
Specifies physical link's source NE name | --- |
baselineTime | String string |
Specifies time at which baseline scan result processed. | --- |
id | String string |
Specifies sequence number of otdr scan result list | --- |
destNE | String string |
Specifies physical link's destination NE name | --- |
baselineFiberLength | String string |
Specifies baseline fiber length (KMtrs by defualt) | --- |
lastScanLength | String string |
Specifies last scan fiber length (KMtrs by default) | --- |
destNeId | String string |
Specifies physical link's destination NE Id | --- |
lastScanTime | String string |
Specifies time at which last otdr scan result processed | --- |
phyLinkId | String string |
Specifies Physical link's connection Id | --- |
lastScanFilename | String string |
Otdr last scan result file name. Prefix filename with https:// |
--- |
userEnteredLength | String string |
Specifies user specified fiber length | --- |
destPort | String string |
Specifies Physical link's destination port name. | --- |
span | String string |
Specifies Physical link's span - AZ or ZA direction | --- |