Operation

post /data/otn/darkfiber/associate/phylinks
associateDarkFiberWithPhysicalLinks (associateDarkFiberWithPhysicalLinks : /data/otn/darkfiber/associate/phylinks)
associateDarkFiberWithPhysicalLinks

Request body

Name

IsRequired

Description

Data Type

Enum

body optional PFDLAssoc String ---

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:
    • application/json
    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

    post /data/otn/darkfibers/associate/phylinks
    associateDarkFiberWithPhysicalLinks (associateDarkFiberWithPhysicalLinks : /data/otn/darkfibers/associate/phylinks)
    associateDarkFiberWithPhysicalLinks

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional PFDLAssoc String ---

    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:
    • application/json
    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

    post /data/otn/darkfiber
    createdf (createdf : /data/otn/darkfiber)
    createdf

    Query parameters

    Name

    IsRequired

    Description

    darkfiberdata required ---
    spooldata optional ---
    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;charset=UTF-8
    • application/json

    External Docs
    See Also :

    Operation

    post /data/otn/darkfibers
    createdf (createdf : /data/otn/darkfibers)
    createdf

    Query parameters

    Name

    IsRequired

    Description

    darkfiberdata required ---
    spooldata optional ---
    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;charset=UTF-8
    • application/json

    External Docs
    See Also :

    Operation

    delete /data/otn/darkfiber
    deleteDarkFibers (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
    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

    delete /data/otn/darkfibers
    deleteDarkFibers (deleteDarkFibers : /data/otn/darkfibers)
    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
    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

    delete /data/otn/darkfiber/gis/deleteFiberAssoc/{dfID}
    deleteFiberRouteAssociation (deleteFiberRouteAssociation : /data/otn/darkfiber/gis/deleteFiberAssoc/{dfID})
    deleteFiberRouteAssociation

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfID required dfID ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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

    delete /data/otn/darkfibers/gis/deleteFiberAssoc/{dfID}
    deleteFiberRouteAssociation (deleteFiberRouteAssociation : /data/otn/darkfibers/gis/deleteFiberAssoc/{dfID})
    deleteFiberRouteAssociation

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfID required dfID ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    401Unauthorized ---
    204No Content ---
    403Forbidden ---
    Consumes
    This API call consumes the following media types via the Content-Type request header:
    • application/json
    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

    post /data/otn/darkfiber/disassociate/phylinks
    dissociatePhysicalLinkWithDarkFibers (dissociatePhysicalLinkWithDarkFibers : /data/otn/darkfiber/disassociate/phylinks)
    dissociatePhysicalLinkWithDarkFibers

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional phyLinkIds String ---

    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:
    • application/json
    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

    post /data/otn/darkfibers/disassociate/phylinks
    dissociatePhysicalLinkWithDarkFibers (dissociatePhysicalLinkWithDarkFibers : /data/otn/darkfibers/disassociate/phylinks)
    dissociatePhysicalLinkWithDarkFibers

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional phyLinkIds String ---

    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:
    • application/json
    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}/darkfiberList
    getAssociatedDarkFiberForPhysicalLink (getAssociatedDarkFiberForPhysicalLink : /data/otn/darkfiber/{id}/darkfiberList)
    getAssociatedDarkFiberForPhysicalLink

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • DarkFiberResponseData«object»
  • Responses

    Response Messages

    Schema

    200success DarkFiberResponseData«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/darkfibers/{id}/darkfiberList
    getAssociatedDarkFiberForPhysicalLink (getAssociatedDarkFiberForPhysicalLink : /data/otn/darkfibers/{id}/darkfiberList)
    getAssociatedDarkFiberForPhysicalLink

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • DarkFiberResponseData«object»
  • Responses

    Response Messages

    Schema

    200success DarkFiberResponseData«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/{id}/physicalConns
    getAssociatedPhyLinksForDarkFiber (getAssociatedPhyLinksForDarkFiber : /data/otn/darkfiber/{id}/physicalConns)
    getAssociatedPhyLinksForDarkFiber

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    action required ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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/darkfibers/{id}/physicalConns
    getAssociatedPhyLinksForDarkFiber (getAssociatedPhyLinksForDarkFiber : /data/otn/darkfibers/{id}/physicalConns)
    getAssociatedPhyLinksForDarkFiber

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---
    Query parameters

    Name

    IsRequired

    Description

    action required ---

    Return type
  • String
  • Responses

    Response Messages

    Schema

    200success String
    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
    getDarkFiberList (getDarkFiberList : /data/otn/darkfiber)
    getDarkFiberList


    Return type
  • DarkFiberResponseData«object»
  • Responses

    Response Messages

    Schema

    200success DarkFiberResponseData«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/darkfibers
    getDarkFiberList (getDarkFiberList : /data/otn/darkfibers)
    getDarkFiberList


    Return type
  • DarkFiberResponseData«object»
  • Responses

    Response Messages

    Schema

    200success DarkFiberResponseData«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/{id}
    getDarkFiberbyID (getDarkFiberbyID : /data/otn/darkfiber/{id})
    getDarkFiberbyID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • DarkFiberResponseData«object»
  • Responses

    Response Messages

    Schema

    200success DarkFiberResponseData«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/darkfibers/{id}
    getDarkFiberbyID (getDarkFiberbyID : /data/otn/darkfibers/{id})
    getDarkFiberbyID

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • DarkFiberResponseData«object»
  • Responses

    Response Messages

    Schema

    200success DarkFiberResponseData«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}
    getOtdrScanResultByDfId (getOtdrScanResultByDfId : /data/otn/darkfiber/scanresult/{dfId})
    getOtdrScanResultByDfId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

    Return type
  • List[Map«string,object»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,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/darkfibers/scanresult/{dfId}
    getOtdrScanResultByDfId (getOtdrScanResultByDfId : /data/otn/darkfibers/scanresult/{dfId})
    getOtdrScanResultByDfId

    Path parameters

    Name

    IsRequired

    Description

    Enum

    dfId required dfId ---

    Return type
  • List[Map«string,object»]
  • Responses

    Response Messages

    Schema

    200success List[Map«string,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

    post /data/otn/darkfiber/{id}
    modifyDarkFiber (modifyDarkFiber : /data/otn/darkfiber/{id})
    modifyDarkFiber

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

    Operation

    post /data/otn/darkfibers/{id}
    modifyDarkFiber (modifyDarkFiber : /data/otn/darkfibers/{id})
    modifyDarkFiber

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

    DarkFiberResponse

    Name

    Type

    Description

    Enum

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

    DarkFiberResponseData«object»

    Name

    Type

    Description

    Enum

    identifier String string --- ---
    items array[Object] object --- ---
    status String string --- ---
    message String string --- ---

    MultipartFile

    Name

    Type

    Description

    Enum