Operation

post /data/otn/darkfiber
Create darkfiber (createdf : /data/otn/darkfiber)
This method used to create darkfiber/otdr association/Kml file assocation based on user input

Query parameters

Name

IsRequired

Description

darkfiberdata required darkfiberdata
spooldata optional spoolData
Form parameters

Name

Description

afilelist (optional) afilelistdefault:
zfilelist (optional) zfilelistdefault:

Return type
  • DarkFiberResponse
  • Responses

    Response Messages

    Schema

    200success DarkFiberResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • 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
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json;charset=UTF-8
    • application/json
    Example Response Data
    { "message":"Dark fiber service created successfully.", "status":"Success", "identifier":"1" }

    External Docs
    See Also :

    Operation

    delete /data/otn/darkfiber
    to delete Dark Fibers (deleteDarkFibers : /data/otn/darkfiber)
    deleteDarkFibers

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional darkFiberIds array[Integer] ---

    Return type
  • DarkFiberResponse
  • Responses

    Response Messages

    Schema

    200success DarkFiberResponse
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    [ 61, 62, 65 ]

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • 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
    See Also :

    Operation

    post /data/otn/darkfiber/disassociate/phylinks
    to dissociate the passed physical link from associated darkfibers. (dissociatePhysicalLinkWithDarkFibers : /data/otn/darkfiber/disassociate/phylinks)
    dissociatePhysicalLinkWithDarkFibers

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional phyLinkIds String ---

    Return type
  • DarkFiberList
  • Responses

    Response Messages

    Schema

    200success DarkFiberList
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    Example Request Data

    { "phyLinkIds":[ 3, 4, 7 ] }

    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json
    Example Response Data
    { "message":"Successfully dissociated darkfiber 1 from physical link id/s 2", "status":"success", "identifier":"1" }

    External Docs
    See Also :

    Operation

    get /data/otn/darkfiber/{id}/physicalConns
    to retrieve all physical links for associate / disassociate based on the action passed in (getAssociatedPhyLinksForDarkFiber : /data/otn/darkfiber/{id}/physicalConns)
    getAssociatedPhyLinksForDarkFiber

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    action required actionName

    Return type
  • ResponseDtModel
  • Responses

    Response Messages

    Schema

    200success ResponseDtModel
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/otn/darkfiber
    to retrieve Dark Fibers (getDarkFiberList : /data/otn/darkfiber)
    getDarkFiberList


    Return type
  • DarkFiberList
  • Responses

    Response Messages

    Schema

    200success DarkFiberList
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/otn/darkfiber/{id}
    to get Dark Fiber details based on id (getDarkFiberbyID : /data/otn/darkfiber/{id})
    getDarkFiberbyID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • ResponseDtModel«object»
  • Responses

    Response Messages

    Schema

    200success ResponseDtModel«object»
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    Operation

    get /data/otn/darkfiber/scanresult/{dfId}
    Get otdr scan results for the specified darkfiber. Returns list of map containing key value pairs. (getOtdrScanResultByDfId : /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
  • OtdrScanResultResponse
  • Responses

    Response Messages

    Schema

    200success OtdrScanResultResponse
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • 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" } ]

    External Docs
    See Also :
  • deleteDarkFibers : /data/otn/darkfiber

  • Operation

    post /data/otn/darkfiber/{id}
    to modify Dark Fiber based on id (modifyDarkFiber : /data/otn/darkfiber/{id})
    modifyDarkFiber

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    darkfiberdata required darkfiberdata
    spooldata optional spoolData
    Form parameters

    Name

    Description

    afilelist (optional) afilelistdefault:
    zfilelist (optional) zfilelistdefault:

    Return type
  • DarkFiberResponse
  • Responses

    Response Messages

    Schema

    200success DarkFiberResponse
    201Created ---
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • multipart/form-data
    Produces
    This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.
    • application/json

    External Docs
    See Also :

    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 --- ---

    DarkFiberList

    Name

    Type

    Description

    Enum

    dflist array[DarkFiber] DarkFiber --- ---
    message String string --- ---
    status String string --- ---
    identifier String string --- ---

    DarkFiberResponse

    Name

    Type

    Description

    Enum

    message String string --- ---
    status String string --- ---
    identifier String string --- ---

    File

    Name

    Type

    Description

    Enum

    path String string --- ---
    name String string --- ---
    parent String string --- ---
    absolute Boolean boolean --- ---
    canonicalPath String string --- ---
    parentFile file file --- ---
    absolutePath String string --- ---
    absoluteFile file file --- ---
    canonicalFile file file --- ---
    directory Boolean boolean --- ---
    file Boolean boolean --- ---
    hidden Boolean boolean --- ---
    lastModified Long long --- ---
    writable Boolean boolean --- ---
    readable Boolean boolean --- ---
    executable Boolean boolean --- ---
    totalSpace Long long --- ---
    freeSpace Long long --- ---
    usableSpace Long long --- ---

    InputStream

    Name

    Type

    Description

    Enum

    MultipartFile

    Name

    Type

    Description

    Enum

    originalFilename String string --- ---
    contentType String string --- ---
    name String string --- ---
    empty Boolean boolean --- ---
    bytes array[String] string --- ---
    resource Resource Resource --- ---
    size Long long --- ---
    inputStream InputStream InputStream --- ---

    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://:/oms1350/otn/schedule/otdr/file/ to download file from server. ---
    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://:/oms1350/otn/schedule/otdr/file/ to download file from server. ---
    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 ---

    Resource

    Name

    Type

    Description

    Enum

    filename String string --- ---
    description String string --- ---
    readable Boolean boolean --- ---
    file file file --- ---
    open Boolean boolean --- ---
    inputStream InputStream InputStream --- ---

    ResponseDtModel

    Name

    Type

    Description

    Enum

    identifier String string Identifer attribute ---
    items array[Object] object Items attribute ---
    status String string Status attribute ---
    message String string Message attribute ---

    ResponseDtModel«object»

    Name

    Type

    Description

    Enum

    identifier String string Identifer attribute ---
    items array[Object] object Items attribute ---
    status String string Status attribute ---
    message String string Message attribute ---

    TimeZone

    Name

    Type

    Description

    Enum

    rawOffset Integer integer --- ---
    displayName String string --- ---