Operation

get /eqm/otdr/cardName/{neGroupId}/{neId}/{ptpName}
getCardName (getCardName : /eqm/otdr/cardName/{neGroupId}/{neId}/{ptpName})
getCardName

Path parameters

Name

IsRequired

Description

Enum

neGroupId required neGroupId ---
neId required neId ---
ptpName required ptpName ---

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.
    • text/plain

    External Docs
    See Also :

    Operation

    get /eqm/otdr/listFilesOfEML/{neName}
    getListOfEMLFiles (getListOfEMLFiles : /eqm/otdr/listFilesOfEML/{neName})
    getListOfEMLFiles

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName ---
    Query parameters

    Name

    IsRequired

    Description

    neId optional neId
    neGroupId optional neGroupId

    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[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 /eqm/otdr/neSummaryDetails/{neName}
    getNeSummaryDetails (getNeSummaryDetails : /eqm/otdr/neSummaryDetails/{neName})
    getNeSummaryDetails

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName ---

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    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 /eqm/otdr/retrieveResults/{neID}/{grpID}/{ptpName}/{fileName}
    getOtdrFileResults (getOtdrFileResults : /eqm/otdr/retrieveResults/{neID}/{grpID}/{ptpName}/{fileName})
    getOtdrFileResults

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---
    fileName required fileName ---

    Return type
  • Status
  • Responses

    Response Messages

    Schema

    200success Status
    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 /eqm/otdr/portProfile/{ptpName}
    getOtdrPortDetails (getOtdrPortDetails : /eqm/otdr/portProfile/{ptpName})
    getOtdrPortDetails

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ptpName required ptpName ---
    Query parameters

    Name

    IsRequired

    Description

    neName optional neName
    neId optional neId
    neGroupId optional neGroupId

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    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 /eqm/otdr/portScan/{ptpName}
    getOtdrPortScanStatus (getOtdrPortScanStatus : /eqm/otdr/portScan/{ptpName})
    getOtdrPortScanStatus

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ptpName required ptpName ---
    Query parameters

    Name

    IsRequired

    Description

    neName optional neName
    neId optional neId
    neGroupId optional neGroupId

    Return type
  • inline_response_200
  • Responses

    Response Messages

    Schema

    200success inline_response_200
    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 /eqm/otdr/otdrPorts/{neName}
    getOtdrPorts (getOtdrPorts : /eqm/otdr/otdrPorts/{neName})
    getOtdrPorts

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName ---
    Query parameters

    Name

    IsRequired

    Description

    neId optional neId
    neGroupId optional neGroupId

    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[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

    post /eqm/otdr/modifyOtdrParams/{ptpName}
    modifyTpSettings (modifyTpSettings : /eqm/otdr/modifyOtdrParams/{ptpName})
    modifyTpSettings

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ptpName required ptpName ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional otdrEntity OtdrEntity ---
    body2 optional session1 HttpSession ---
    Query parameters

    Name

    IsRequired

    Description

    neName optional neName
    neId optional neId
    neGroupId optional neGroupId

    Return type
  • Status
  • Responses

    Response Messages

    Schema

    200success Status
    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 /eqm/otdr/retrieveFileList/{neID}/{grpID}/{ptpName}/{fileName}
    retrieveFileList (retrieveFileList : /eqm/otdr/retrieveFileList/{neID}/{grpID}/{ptpName}/{fileName})
    retrieveFileList

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---
    fileName required fileName ---

    Return type
  • array[String]
  • Responses

    Response Messages

    Schema

    200success array[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

    post /eqm/otdr/scan/{neID}/{grpID}/{ptpName}/{cmd}
    setOtdrScan (setOtdrScan : /eqm/otdr/scan/{neID}/{grpID}/{ptpName}/{cmd})
    setOtdrScan

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---
    cmd required cmd ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional session1 HttpSession ---

    Return type
  • Status
  • Responses

    Response Messages

    Schema

    200success Status
    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 /eqm/otdr/transferFile/{neID}/{grpID}/{ptpName}/{fileName}/{fileLoc}
    transferFileFromEMLtoOtnStatus (transferFileFromEMLtoOtnStatus : /eqm/otdr/transferFile/{neID}/{grpID}/{ptpName}/{fileName}/{fileLoc})
    transferFileFromEMLtoOtnStatus

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neID required neID ---
    grpID required grpID ---
    ptpName required ptpName ---
    fileName required fileName ---
    fileLoc required fileLoc ---

    Return type
  • Status
  • Responses

    Response Messages

    Schema

    200success Status
    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 /eqm/otdr/transferFileToPC/{fileName}
    transferFileFromOtntoPC (transferFileFromOtntoPC : /eqm/otdr/transferFileToPC/{fileName})
    transferFileFromOtntoPC

    Path parameters

    Name

    IsRequired

    Description

    Enum

    fileName required fileName ---

    Responses

    Response Messages

    Schema

    200OK ---
    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.
    • */*

    External Docs
    See Also :

    HashMap«string,OtdrParameter»

    Name

    Type

    Description

    Enum

    inline_response_200

    Name

    Type

    Description

    Enum

    OtdrEntity

    Name

    Type

    Description

    Enum

    entityType String string --- ---
    groupId String string --- ---
    neId String string --- ---
    entityName String string --- ---
    paramList array[OtdrParameter] OtdrParameter --- ---
    paramListAsMap HashMap«string,OtdrParameter» HashMap«string,OtdrParameter» --- ---

    OtdrParameter

    Name

    Type

    Description

    Enum

    name String string --- ---
    value String string --- ---
    isModified Boolean boolean --- ---

    Status

    Name

    Type

    Description

    Enum

    opStatus String string Operation Status ---
    msg String string Operation Message ---

    Void

    Name

    Type

    Description

    Enum