Operation

post /SetNE/asapSet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}
Overides the severity of the alarm condition at Shelf and Card level. (modifyShelforCardLevelAsap : /SetNE/asapSet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category})
The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN or 1830VWM Network Element retrieved from the call /data/npr/nes.1830VWM supports ASAP only at shelf level.
To set the Alarm severity for VWM the payload value would be of the format 'connections: cond__' and 'severity : _' and
similarly to set the reported field value for VWM the payload format is 'connections:rep__' and 'severity : _'
.Allowable Values for Severity for VWM are [none,cleared,indeterminate,critical,major,minor,warning] and for reported :[true,false].
Only EQPT category is supported for 1830VWM.

Path parameters

Name

IsRequired

Description

Enum

groupId required EML Group ID ---
neId required EML Network Element ID ---
clickedEntity required Shelf/Card Access Identifier ---
category required Alarm Category [EQPT]
Request body

Name

IsRequired

Description

Data Type

Enum

body optional asapArray array[ASAPDetail] ---

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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /SetNE/asapSet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}
    Overides the severity of the alarm condition at Shelf and Card level. (modifyShelforCardLevelAsap : /SetNE/asapSet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    clickedEntity required Shelf/Card Access Identifier ---
    category required Alarm Category ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /asap/asapSet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}
    Overides the severity of the alarm condition at Shelf and Card level. (modifyShelforCardLevelAsap : /asap/asapSet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN or 1830VWM Network Element retrieved from the call /data/npr/nes.1830VWM supports ASAP only at shelf level.
    To set the Alarm severity for VWM the payload value would be of the format 'connections: cond__' and 'severity : _' and
    similarly to set the reported field value for VWM the payload format is 'connections:rep__' and 'severity : _'
    .Allowable Values for Severity for VWM are [none,cleared,indeterminate,critical,major,minor,warning] and for reported :[true,false].
    Only EQPT category is supported for 1830VWM.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    clickedEntity required Shelf/Card Access Identifier ---
    category required Alarm Category [EQPT]
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional asapArray array[ASAPDetail] ---

    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
    Example Request Data

    REST call: /asap/asapSet/shelforCardLevel/6601/13/SHELF-1/EQPT PHN Request Payload: ====================== [ { "connections": "CONTCOM", "severity": "MJ" }, { "connections": "MISMATCH", "severity": "CR" } ] VWM Request Payload: ==================== [ { "connections": "cond_replUnitMiss_faultLocIntfManagementPlane", "severity": "indeterminate_faultLocIntfManagementPlane" }, { "connections": "rep_trmt_faultLocIntfDataPlane", "severity": "false_faultLocIntfDataPlane" } ]

    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/xml
    Example Response Data
    <Status> <opStatus>SUCCESS</opStatus> </Status>
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /asap/asapSet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}
    Overides the severity of the alarm condition at Shelf and Card level. (modifyShelforCardLevelAsap : /asap/asapSet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    clickedEntity required Shelf/Card Access Identifier ---
    category required Alarm Category ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /swap/asapSet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}
    Overides the severity of the alarm condition at Shelf and Card level. (modifyShelforCardLevelAsap : /swap/asapSet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN or 1830VWM Network Element retrieved from the call /data/npr/nes.1830VWM supports ASAP only at shelf level.
    To set the Alarm severity for VWM the payload value would be of the format 'connections: cond__' and 'severity : _' and
    similarly to set the reported field value for VWM the payload format is 'connections:rep__' and 'severity : _'
    .Allowable Values for Severity for VWM are [none,cleared,indeterminate,critical,major,minor,warning] and for reported :[true,false].
    Only EQPT category is supported for 1830VWM.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    clickedEntity required Shelf/Card Access Identifier ---
    category required Alarm Category [EQPT]
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional asapArray array[ASAPDetail] ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /swap/asapSet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}
    Overides the severity of the alarm condition at Shelf and Card level. (modifyShelforCardLevelAsap : /swap/asapSet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    clickedEntity required Shelf/Card Access Identifier ---
    category required Alarm Category ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /SetNE/activate/neLevel/{groupId}/{neId}
    Activates the Card Migration on NE. (phnNeSubmitAsapConditionsWithSeverity : /SetNE/activate/neLevel/{groupId}/{neId})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /SetNE/asapSet/neLevel/{groupId}/{neId}/{category}
    Overides the severity of the alarm condition at Network Element level. (phnNeSubmitAsapConditionsWithSeverity : /SetNE/asapSet/neLevel/{groupId}/{neId}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    category required Alarm Category [1GBE, 10GBE, 100GBE, 40GBE, BITS, CBR10G3, CBR2G5, CBRAR, CFMMEP, COM, DDR, E1, ENV, EQPT, ERP, FC100, FC200, FC400, FC800, FC1200, FC1600, FE, LAG, LINEREF, MEP, NETIF, OAMSAACTL, OC3/STM1, OC12/STM4, OC48/STM16, OC192/STM64, OC768/STM256, OCH, ODU0, ODU0TCM, ODU1, ODU1TCM, ODU1F, ODU2, ODU2TCM, ODU2E, ODU2ETCM, ODU3, ODU3TCM, ODU4, ODU4TCM, ODUflex, OMS, OPTSG, OTS, OTU1, OTU1F, OTU2, OTU2E, OTU3, OTU4, PLK, PTPCLOCK, PTPPORT, RMD, RMDCESCHANNEL, RMDIF, RMDIFMAU, RMDMEP, RMDNIM, SAP, SVC, SYNC, SYNCOUT, TOD, TRU, VTS]
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional asapArray array[ASAPDetail] ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /asap/activate/neLevel/{groupId}/{neId}
    Activates the Card Migration on NE. (phnNeSubmitAsapConditionsWithSeverity : /asap/activate/neLevel/{groupId}/{neId})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /asap/asapSet/neLevel/{groupId}/{neId}/{category}
    Overides the severity of the alarm condition at Network Element level. (phnNeSubmitAsapConditionsWithSeverity : /asap/asapSet/neLevel/{groupId}/{neId}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    category required Alarm Category [1GBE, 10GBE, 100GBE, 40GBE, BITS, CBR10G3, CBR2G5, CBRAR, CFMMEP, COM, DDR, E1, ENV, EQPT, ERP, FC100, FC200, FC400, FC800, FC1200, FC1600, FE, LAG, LINEREF, MEP, NETIF, OAMSAACTL, OC3/STM1, OC12/STM4, OC48/STM16, OC192/STM64, OC768/STM256, OCH, ODU0, ODU0TCM, ODU1, ODU1TCM, ODU1F, ODU2, ODU2TCM, ODU2E, ODU2ETCM, ODU3, ODU3TCM, ODU4, ODU4TCM, ODUflex, OMS, OPTSG, OTS, OTU1, OTU1F, OTU2, OTU2E, OTU3, OTU4, PLK, PTPCLOCK, PTPPORT, RMD, RMDCESCHANNEL, RMDIF, RMDIFMAU, RMDMEP, RMDNIM, SAP, SVC, SYNC, SYNCOUT, TOD, TRU, VTS]
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional asapArray array[ASAPDetail] ---

    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
    Example Request Data

    REST call: /asap/asapSet/neLevel/6601/13/1GBE Request Payload: [ { "connections": "VTS4WKSWPR_NONE", "severity": "MN" } ]

    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/xml
    Example Response Data
    <Status> <opStatus>SUCCESS</opStatus> </Status>
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /swap/activate/neLevel/{groupId}/{neId}
    Activates the Card Migration on NE. (phnNeSubmitAsapConditionsWithSeverity : /swap/activate/neLevel/{groupId}/{neId})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /swap/asapSet/neLevel/{groupId}/{neId}/{category}
    Overides the severity of the alarm condition at Network Element level. (phnNeSubmitAsapConditionsWithSeverity : /swap/asapSet/neLevel/{groupId}/{neId}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    category required Alarm Category [1GBE, 10GBE, 100GBE, 40GBE, BITS, CBR10G3, CBR2G5, CBRAR, CFMMEP, COM, DDR, E1, ENV, EQPT, ERP, FC100, FC200, FC400, FC800, FC1200, FC1600, FE, LAG, LINEREF, MEP, NETIF, OAMSAACTL, OC3/STM1, OC12/STM4, OC48/STM16, OC192/STM64, OC768/STM256, OCH, ODU0, ODU0TCM, ODU1, ODU1TCM, ODU1F, ODU2, ODU2TCM, ODU2E, ODU2ETCM, ODU3, ODU3TCM, ODU4, ODU4TCM, ODUflex, OMS, OPTSG, OTS, OTU1, OTU1F, OTU2, OTU2E, OTU3, OTU4, PLK, PTPCLOCK, PTPPORT, RMD, RMDCESCHANNEL, RMDIF, RMDIFMAU, RMDMEP, RMDNIM, SAP, SVC, SYNC, SYNCOUT, TOD, TRU, VTS]
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional asapArray array[ASAPDetail] ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /SetNE/asaplist/{groupId}/{neId}/{portname}/{categories}
    Retrieves the Port level Alarm Severity Profile for 1830PHN (retrieveasapListForPHN : /SetNE/asaplist/{groupId}/{neId}/{portname}/{categories})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 PHN Network Element retrieved from the call /data/npr/nes .
    The 'portname' field value is Card access identifier which can be obtained from the 'aid' field of any Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Card Access Identifier ---
    categories required Alarm Category [EQPT, OCH, OMS, OTS]

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    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
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}
  • getAllEquipment : /eqm/Equipment/All/{grpID}/{neID}

  • Operation

    get /asap/asaplist/{groupId}/{neId}/{portname}/{categories}
    Retrieves the Port level Alarm Severity Profile for 1830PHN (retrieveasapListForPHN : /asap/asaplist/{groupId}/{neId}/{portname}/{categories})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 PHN Network Element retrieved from the call /data/npr/nes .
    The 'portname' field value is Card access identifier which can be obtained from the 'aid' field of any Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Card Access Identifier ---
    categories required Alarm Category [EQPT, OCH, OMS, OTS]

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /asap/asaplist/6601/3/A4PSWG-1-2-LINEIN/EQPT

    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
    [ { "connections": "PRCDRERR-TOPO", "severity": "None", "defaultSeverity": "MN" }, { "connections": "MAN", "severity": "None", "defaultSeverity": "NA" }, { "connections": "INVALIDEGRESS", "severity": "None", "defaultSeverity": "CR" } ]
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}
  • getAllEquipment : /eqm/Equipment/All/{grpID}/{neID}

  • Operation

    get /swap/asaplist/{groupId}/{neId}/{portname}/{categories}
    Retrieves the Port level Alarm Severity Profile for 1830PHN (retrieveasapListForPHN : /swap/asaplist/{groupId}/{neId}/{portname}/{categories})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 PHN Network Element retrieved from the call /data/npr/nes .
    The 'portname' field value is Card access identifier which can be obtained from the 'aid' field of any Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Card Access Identifier ---
    categories required Alarm Category [EQPT, OCH, OMS, OTS]

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    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
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}
  • getAllEquipment : /eqm/Equipment/All/{grpID}/{neID}

  • Operation

    get /SetNE/asaplist24x/{groupId}/{neId}/{portname}/{category}
    Retrieves the Port level Alarm Severity Profile for 1830PHN. (retrieveasapListForPHN24x : /SetNE/asaplist24x/{groupId}/{neId}/{portname}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 PHN Network Element retrieved from the call /data/npr/nes .
    The 'portname' field value is Card access identifier which can be obtained from the 'aid' field of any Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Card Access Identifier ---
    category required Category ---

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    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
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}
  • getAllEquipment : /eqm/Equipment/All/{grpID}/{neID}

  • Operation

    get /asap/asaplist24x/{groupId}/{neId}/{portname}/{category}
    Retrieves the Port level Alarm Severity Profile for 1830PHN. (retrieveasapListForPHN24x : /asap/asaplist24x/{groupId}/{neId}/{portname}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 PHN Network Element retrieved from the call /data/npr/nes .
    The 'portname' field value is Card access identifier which can be obtained from the 'aid' field of any Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Card Access Identifier ---
    category required Category ---

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /asap/asaplist24x/201/9/2UC400-1-2-1/EQPT

    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
    [{"asap":"sysdflt"}]
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}
  • getAllEquipment : /eqm/Equipment/All/{grpID}/{neID}

  • Operation

    get /swap/asaplist24x/{groupId}/{neId}/{portname}/{category}
    Retrieves the Port level Alarm Severity Profile for 1830PHN. (retrieveasapListForPHN24x : /swap/asaplist24x/{groupId}/{neId}/{portname}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 PHN Network Element retrieved from the call /data/npr/nes .
    The 'portname' field value is Card access identifier which can be obtained from the 'aid' field of any Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Card Access Identifier ---
    category required Category ---

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    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
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}
  • getAllEquipment : /eqm/Equipment/All/{grpID}/{neID}

  • Operation

    get /SetNE/asaplist/nelevel/{groupId}/{neId}/{portname}/{categories}
    Retrieves the Network Element level Alarm Severity Profile for 1830PHN. (retrieveasapListForPHNNELevel : /SetNE/asaplist/nelevel/{groupId}/{neId}/{portname}/{categories})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Entity type [NE]
    categories required Alarm Category [1GBE, 10GBE, 100GBE, 40GBE, BITS, CBR10G3, CBR2G5, CBRAR, CFMMEP, COM, DDR, E1, ENV, EQPT, ERP, FC100, FC200, FC400, FC800, FC1200, FC1600, FE, LAG, LINEREF, MEP, NETIF, OAMSAACTL, OC3/STM1, OC12/STM4, OC48/STM16, OC192/STM64, OC768/STM256, OCH, ODU0, ODU0TCM, ODU1, ODU1TCM, ODU1F, ODU2, ODU2TCM, ODU2E, ODU2ETCM, ODU3, ODU3TCM, ODU4, ODU4TCM, ODUflex, OMS, OPTSG, OTS, OTU1, OTU1F, OTU2, OTU2E, OTU3, OTU4, PLK, PTPCLOCK, PTPPORT, RMD, RMDCESCHANNEL, RMDIF, RMDIFMAU, RMDMEP, RMDNIM, SAP, SVC, SYNC, SYNCOUT, TOD, TRU, VTS]

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    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
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /asap/asaplist/nelevel/{groupId}/{neId}/{portname}/{categories}
    Retrieves the Network Element level Alarm Severity Profile for 1830PHN. (retrieveasapListForPHNNELevel : /asap/asaplist/nelevel/{groupId}/{neId}/{portname}/{categories})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Entity type [NE]
    categories required Alarm Category [1GBE, 10GBE, 100GBE, 40GBE, BITS, CBR10G3, CBR2G5, CBRAR, CFMMEP, COM, DDR, E1, ENV, EQPT, ERP, FC100, FC200, FC400, FC800, FC1200, FC1600, FE, LAG, LINEREF, MEP, NETIF, OAMSAACTL, OC3/STM1, OC12/STM4, OC48/STM16, OC192/STM64, OC768/STM256, OCH, ODU0, ODU0TCM, ODU1, ODU1TCM, ODU1F, ODU2, ODU2TCM, ODU2E, ODU2ETCM, ODU3, ODU3TCM, ODU4, ODU4TCM, ODUflex, OMS, OPTSG, OTS, OTU1, OTU1F, OTU2, OTU2E, OTU3, OTU4, PLK, PTPCLOCK, PTPPORT, RMD, RMDCESCHANNEL, RMDIF, RMDIFMAU, RMDMEP, RMDNIM, SAP, SVC, SYNC, SYNCOUT, TOD, TRU, VTS]

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /asap/asaplist/nelevel/6601/12/NE/1GBE

    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
    [ { "connections": "VTS4WKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS1FRCDWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS1LOCKOUTOFPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "LANLOL(RX)", "severity": "None", "defaultSeverity": "CR" }, { "connections": "VTS5MANWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS7WKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS4MANWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS4LOCKOUTOFPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS1WKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VCGLOA(TX)", "severity": "None", "defaultSeverity": "CR" }, { "connections": "VTS7LOCKOUTOFPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-SEFS-PCST-15-MIN(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "USALS(TX)", "severity": "None", "defaultSeverity": "NR" }, { "connections": "VTS10WKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS2FRCDWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS9MANWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-ETHPKTERT-15-MIN(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "VTS8FRCDWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-ETHPKTER-1-DAY(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "T-OPRL-15-MIN(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "VCGSSF(TX)", "severity": "None", "defaultSeverity": "CR" }, { "connections": "WKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS9FRCDWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS8MANWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS7FRCDWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "SSFCLTEGR(TX)", "severity": "None", "defaultSeverity": "NR" }, { "connections": "T-CV-PCS-15-MIN(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "VTS3MANWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS10FRCDWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS8FRCDWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-OPTH-1-DAY(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "LINKDOWN(RX)", "severity": "None", "defaultSeverity": "CR" }, { "connections": "T-SES-PCST-15-MIN(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "UPM(TX)", "severity": "None", "defaultSeverity": "CR" }, { "connections": "VTS1MANWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-OPTH-15-MIN(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "VTS7MANWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "SWMTXMOD", "severity": "None", "defaultSeverity": "CR" }, { "connections": "VTS2MANWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-ES-PCST-15-MIN(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "VTS3WKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS2WKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS10MANWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS6WKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS3FRCDWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "LANRFI(RX)", "severity": "None", "defaultSeverity": "NA" }, { "connections": "FRCDWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "APSCM", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS6FRCDWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS6MANWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS5WKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "LFD(TX)", "severity": "None", "defaultSeverity": "CR" }, { "connections": "T-CV-PCST-1-DAY(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "VTS4FRCDWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "APSB", "severity": "None", "defaultSeverity": "NA" }, { "connections": "LANLSS(RX)", "severity": "None", "defaultSeverity": "CR" }, { "connections": "T-SES-PCS-1-DAY(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "LANLFI(RX)", "severity": "None", "defaultSeverity": "MJ" }, { "connections": "MANWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-ES-PCS-15-MIN(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "VTS6FRCDWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-ETHPKTERT-1-DAY(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "VTS9FRCDWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS7FRCDWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "FEPORTMISMATCH(TX)", "severity": "None", "defaultSeverity": "CR" }, { "connections": "T-OPTL-1-DAY(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "T-CV-PCST-15-MIN(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "WKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS5LOCKOUTOFPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-OPRL-1-DAY(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "T-ETHPKTER-15-MIN(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "VTS2LOCKOUTOFPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS4MANWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS10FRCDWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS8LOCKOUTOFPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "FELANRFI(TX)", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS1FRCDWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS3MANWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS9WKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS8MANWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "FELANLSS(TX)", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS10LOCKOUTOFPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-OPRH-1-DAY(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "T-SES-PCST-1-DAY(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "T-SEFS-PCS-15-MIN(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "LANLOS(RX)", "severity": "None", "defaultSeverity": "CR" }, { "connections": "T-ES-PCS-1-DAY(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "FEPRLF", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS8WKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS3FRCDWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "FRCDWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-SEFS-PCS-1-DAY(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "VTS2FRCDWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS2MANWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "HIBER(RX)", "severity": "None", "defaultSeverity": "MJ" }, { "connections": "VTS7MANWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS5MANWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-SES-PCS-15-MIN(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "FELANLOS(TX)", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS5FRCDWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "LOCKOUTOFPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS9MANWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-OPRH-15-MIN(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "T-ES-PCST-1-DAY(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "MANWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS10MANWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-SEFS-PCST-1-DAY(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "VTS4FRCDWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS1MANWKSWBK", "severity": "None", "defaultSeverity": "NA" }, { "connections": "T-CV-PCS-1-DAY(RX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "T-OPTL-15-MIN(TX)", "severity": "None", "defaultSeverity": "WR" }, { "connections": "VTS6MANWKSWPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "APSMM", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS9LOCKOUTOFPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS3LOCKOUTOFPR", "severity": "None", "defaultSeverity": "NA" }, { "connections": "VTS6LOCKOUTOFPR", "severity": "None", "defaultSeverity": "NA" } ]
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /swap/asaplist/nelevel/{groupId}/{neId}/{portname}/{categories}
    Retrieves the Network Element level Alarm Severity Profile for 1830PHN. (retrieveasapListForPHNNELevel : /swap/asaplist/nelevel/{groupId}/{neId}/{portname}/{categories})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Entity type [NE]
    categories required Alarm Category [1GBE, 10GBE, 100GBE, 40GBE, BITS, CBR10G3, CBR2G5, CBRAR, CFMMEP, COM, DDR, E1, ENV, EQPT, ERP, FC100, FC200, FC400, FC800, FC1200, FC1600, FE, LAG, LINEREF, MEP, NETIF, OAMSAACTL, OC3/STM1, OC12/STM4, OC48/STM16, OC192/STM64, OC768/STM256, OCH, ODU0, ODU0TCM, ODU1, ODU1TCM, ODU1F, ODU2, ODU2TCM, ODU2E, ODU2ETCM, ODU3, ODU3TCM, ODU4, ODU4TCM, ODUflex, OMS, OPTSG, OTS, OTU1, OTU1F, OTU2, OTU2E, OTU3, OTU4, PLK, PTPCLOCK, PTPPORT, RMD, RMDCESCHANNEL, RMDIF, RMDIFMAU, RMDMEP, RMDNIM, SAP, SVC, SYNC, SYNCOUT, TOD, TRU, VTS]

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    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
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /SetNE/asapGet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}
    Retrieves the Shelf and Card Alarm Severity Profile for 1830PHN or 1830VWM.\nOnly EQPT category is supported for 1830VWM. (retriveShelforCardLevelAsap : /SetNE/asapGet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN or 1830VWM Network Element retrieved from the call /data/npr/nes .
    1830VWM supports ASAP only at shelf level.
    .The 'clickedEntity' field value is Shelf or Card access identifier which can be obtained from the 'aid' field of any Shelf/Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    clickedEntity required Entity Type : Shelf or Card Access Identifier ---
    category required Alarm Category [EQPT]

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    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
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /SetNE/asapGet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity}
    Retrieves the Shelf and Card Alarm Severity Profile for 1830PHN. (retriveShelforCardLevelAsap : /SetNE/asapGet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 PHN Network Element retrieved from the call /data/npr/nes .
    The 'clickedEntity' field value is Shelf or Card access identifier which can be obtained from the 'aid' field of any Shelf/Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    clickedEntity required Entity Type : Shelf or Card Access Identifier ---

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    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
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /asap/asapGet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}
    Retrieves the Shelf and Card Alarm Severity Profile for 1830PHN or 1830VWM.\nOnly EQPT category is supported for 1830VWM. (retriveShelforCardLevelAsap : /asap/asapGet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN or 1830VWM Network Element retrieved from the call /data/npr/nes .
    1830VWM supports ASAP only at shelf level.
    .The 'clickedEntity' field value is Shelf or Card access identifier which can be obtained from the 'aid' field of any Shelf/Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    clickedEntity required Entity Type : Shelf or Card Access Identifier ---
    category required Alarm Category [EQPT]

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /asap/asapGet/shelforCardLevel/6601/12/SHELF-1/EQPT

    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
    PHN: ----- [ { "connections": "CONTCOM", "severity": "None", "defaultSeverity": "CR" }, { "connections": "MISMATCH", "severity": "None", "defaultSeverity": "CR" }, { "connections": "SWEQPT", "severity": "None", "defaultSeverity": "MN" }, { "connections": "MIXEDPFUSED", "severity": "None", "defaultSeverity": "CR" }, { "connections": "SPIREADERROR", "severity": "None", "defaultSeverity": "CR" }, { "connections": "SHELFINCON", "severity": "None", "defaultSeverity": "CR" } ] VWM: --------- [ { "connections": null, "severity": "major", "defaultSeverity": null, "cause": "eqpt", "locationType": "faultLocSlot", "reported": "true", "serviceAffecting": "false", "alarmText": "Equipment Failure of Card", "uiId": "eqpt_faultLocSlot", "name": null, "value": null }, { "connections": null, "severity": "minor", "defaultSeverity": null, "cause": "los", "locationType": "faultLocIntfManagementPlane", "reported": "true", "serviceAffecting": "false", "alarmText": "Loss of Signal on Management Port", "uiId": "los_faultLocIntfManagementPlane", "name": null, "value": null }, { "connections": null, "severity": "minor", "defaultSeverity": null, "cause": "opr", "locationType": "faultLocIntfDataPlane", "reported": "true", "serviceAffecting": "false", "alarmText": "Optical Power Received out of range on Data Port", "uiId": "opr_faultLocIntfDataPlane", "name": null, "value": null }, { "connections": null, "severity": "critical", "defaultSeverity": null, "cause": "opr", "locationType": "faultLocIntfManagementPlane", "reported": "true", "serviceAffecting": "false", "alarmText": "Optical Power Received out of range on Management Port", "uiId": "opr_faultLocIntfManagementPlane", "name": null, "value": null }, { "connections": null, "severity": "minor", "defaultSeverity": null, "cause": "replUnitMiss", "locationType": "faultLocIntfManagementPlane", "reported": "true", "serviceAffecting": "false", "alarmText": "Management Port SFP not present", "uiId": "replUnitMiss_faultLocIntfManagementPlane", "name": null, "value": null }, { "connections": null, "severity": "critical", "defaultSeverity": null, "cause": "trmt", "locationType": "faultLocIntfDataPlane", "reported": "false", "serviceAffecting": "true", "alarmText": "Transmit Power Level out of range on Data Port", "uiId": "trmt_faultLocIntfDataPlane", "name": null, "value": null }, { "connections": null, "severity": "minor", "defaultSeverity": null, "cause": "trmt", "locationType": "faultLocIntfManagementPlane", "reported": "true", "serviceAffecting": "false", "alarmText": "Transmit Power Level out of range on Management Port", "uiId": "trmt_faultLocIntfManagementPlane", "name": null, "value": null }, { "connections": null, "severity": "minor", "defaultSeverity": null, "cause": "unknown", "locationType": "faultLocIntfManagementPlane", "reported": "true", "serviceAffecting": "false", "alarmText": "Unknown SFP in Management Port", "uiId": "unknown_faultLocIntfManagementPlane", "name": null, "value": null }, { "connections": null, "severity": "warning", "defaultSeverity": null, "cause": "UNIINIT", "locationType": "faultLocSlot", "reported": "false", "serviceAffecting": "false", "alarmText": "Card initialization in progress", "uiId": "UNIINIT_faultLocSlot", "name": null, "value": null }, { "connections": null, "severity": "minor", "defaultSeverity": null, "cause": "facTermDev", "locationType": "faultLocIntfManagementPlane", "reported": "true", "serviceAffecting": "false", "alarmText": "Inventory data corrupt", "uiId": "facTermDev_faultLocIntfManagementPlane", "name": null, "value": null }, { "connections": null, "severity": "minor", "defaultSeverity": null, "cause": "eqptDgr", "locationType": "faultLocIntfManagementPlane", "reported": "true", "serviceAffecting": "false", "alarmText": "Equipment Degraded Condition on SFP in Management Port", "uiId": "eqptDgr_faultLocIntfManagementPlane", "name": null, "value": null }, { "connections": null, "severity": "minor", "defaultSeverity": null, "cause": "intTempHigh", "locationType": "faultLocShelf", "reported": "true", "serviceAffecting": "false", "alarmText": "High Temperature of Shelf", "uiId": "intTempHigh_faultLocShelf", "name": null, "value": null }, { "connections": null, "severity": "minor", "defaultSeverity": null, "cause": "intTempHigh", "locationType": "faultLocIntfManagementPlane", "reported": "true", "serviceAffecting": "false", "alarmText": "High Temperature of SFP in Management Port", "uiId": "intTempHigh_faultLocIntfManagementPlane", "name": null, "value": null } ]
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /asap/asapGet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity}
    Retrieves the Shelf and Card Alarm Severity Profile for 1830PHN. (retriveShelforCardLevelAsap : /asap/asapGet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 PHN Network Element retrieved from the call /data/npr/nes .
    The 'clickedEntity' field value is Shelf or Card access identifier which can be obtained from the 'aid' field of any Shelf/Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    clickedEntity required Entity Type : Shelf or Card Access Identifier ---

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    401Unauthorized ---
    403Forbidden ---
    404Not Found ---
    Example Request Data

    /asap/asapGet24x/shelforCardLevel/201/9/SHELF-1

    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
    [{"EQPT_asap":"sysdflt"}]
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /swap/asapGet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category}
    Retrieves the Shelf and Card Alarm Severity Profile for 1830PHN or 1830VWM.\nOnly EQPT category is supported for 1830VWM. (retriveShelforCardLevelAsap : /swap/asapGet/shelforCardLevel/{groupId}/{neId}/{clickedEntity}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN or 1830VWM Network Element retrieved from the call /data/npr/nes .
    1830VWM supports ASAP only at shelf level.
    .The 'clickedEntity' field value is Shelf or Card access identifier which can be obtained from the 'aid' field of any Shelf/Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    clickedEntity required Entity Type : Shelf or Card Access Identifier ---
    category required Alarm Category [EQPT]

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    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
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    get /swap/asapGet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity}
    Retrieves the Shelf and Card Alarm Severity Profile for 1830PHN. (retriveShelforCardLevelAsap : /swap/asapGet24x/shelforCardLevel/{groupId}/{neId}/{clickedEntity})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830 PHN Network Element retrieved from the call /data/npr/nes .
    The 'clickedEntity' field value is Shelf or Card access identifier which can be obtained from the 'aid' field of any Shelf/Card equipment retrieved from the call /eqm/Equipment/All/{grpID}/{neID}.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    clickedEntity required Entity Type : Shelf or Card Access Identifier ---

    Return type
  • ASAPDetail
  • Responses

    Response Messages

    Schema

    200success ASAPDetail
    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
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /SetNE/systemInfo/{groupId}/{neId}
    Set System Info of Network Element. (setSystemInfoforNE : /SetNE/systemInfo/{groupId}/{neId})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional systemInfoParams array[ASAPDetail] ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /asap/systemInfo/{groupId}/{neId}
    Set System Info of Network Element. (setSystemInfoforNE : /asap/systemInfo/{groupId}/{neId})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional systemInfoParams array[ASAPDetail] ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /swap/systemInfo/{groupId}/{neId}
    Set System Info of Network Element. (setSystemInfoforNE : /swap/systemInfo/{groupId}/{neId})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional systemInfoParams array[ASAPDetail] ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /SetNE/asapSet/portLevel/{groupId}/{neId}/{portname}/{category}
    Overides the severity of the alarm condition at port level. (submitasapAlarmsWithSeverityForPHN : /SetNE/asapSet/portLevel/{groupId}/{neId}/{portname}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Port Access Identifier ---
    category required Alarm Category [EQPT, OCH, OMS, OTS]
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional asapArray array[ASAPDetail] ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /asap/asapSet/portLevel/{groupId}/{neId}/{portname}/{category}
    Overides the severity of the alarm condition at port level. (submitasapAlarmsWithSeverityForPHN : /asap/asapSet/portLevel/{groupId}/{neId}/{portname}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Port Access Identifier ---
    category required Alarm Category [EQPT, OCH, OMS, OTS]
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional asapArray array[ASAPDetail] ---

    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
    Example Request Data

    REST call: /asap/asapSet/portLevel/6601/3/A4PSWG-1-2-LINEIN/EQPT Request Payload: [ { "connections": "PRCDRERR-TOPO_NONE", "severity": "MJ" } ]

    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/xml
    Example Response Data
    <Status> <opStatus>SUCCESS</opStatus> <msg>ASAP Modify A4PSWG-1-2-LINEIN </msg> </Status>
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /swap/asapSet/portLevel/{groupId}/{neId}/{portname}/{category}
    Overides the severity of the alarm condition at port level. (submitasapAlarmsWithSeverityForPHN : /swap/asapSet/portLevel/{groupId}/{neId}/{portname}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Port Access Identifier ---
    category required Alarm Category [EQPT, OCH, OMS, OTS]
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional asapArray array[ASAPDetail] ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /SetNE/asapSet24x/portLevel/{groupId}/{neId}/{portname}/{category}
    Overides the severity of the alarm condition at port level. (submitasapCategoryFor24x : /SetNE/asapSet24x/portLevel/{groupId}/{neId}/{portname}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Port Access Identifier ---
    category required Alarm Category ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /asap/asapSet24x/portLevel/{groupId}/{neId}/{portname}/{category}
    Overides the severity of the alarm condition at port level. (submitasapCategoryFor24x : /asap/asapSet24x/portLevel/{groupId}/{neId}/{portname}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Port Access Identifier ---
    category required Alarm Category ---

    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
    Example Request Data

    REST call: /asap/asapSet24x/portLevel/201/9/30AN300-1-1-1/EQPT_sysdflt

    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/xml
    Example Response Data
    <Status> <opStatus>SUCCESS</opStatus> <msg>ASAP Modify 30AN300-1-1-1 </msg> </Status>
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • Operation

    post /swap/asapSet24x/portLevel/{groupId}/{neId}/{portname}/{category}
    Overides the severity of the alarm condition at port level. (submitasapCategoryFor24x : /swap/asapSet24x/portLevel/{groupId}/{neId}/{portname}/{category})
    The 'groupId' and 'neId' field values can be obtained from the 'emlDomId' and 'emlNeId' fields respectively of any 1830PHN Network Element retrieved from the call /data/npr/nes.

    Path parameters

    Name

    IsRequired

    Description

    Enum

    groupId required EML Group ID ---
    neId required EML Network Element ID ---
    portname required Port Access Identifier ---
    category required Alarm Category ---

    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/xml
    Tags
    [ EQM ]

    External Docs
    See Also :
  • get : /data/npr/{table}

  • ASAPDetail

    Name

    Type

    Description

    Enum

    connections String string Alarm Conditions [1GBE, 10GBE, 100GBE, 40GBE, BITS, CBR10G3, CBR2G5, CBRAR, CFMMEP, COM, DDR, E1, ENV, EQPT, ERP, FC100, FC200, FC400, FC800, FC1200, FC1600, FE, LAG, LINEREF, MEP, NETIF, OAMSAACTL, OC3/STM1, OC12/STM4, OC48/STM16, OC192/STM64, OC768/STM256, OCH, ODU0, ODU0TCM, ODU1, ODU1TCM, ODU1F, ODU2, ODU2TCM, ODU2E, ODU2ETCM, ODU3, ODU3TCM, ODU4, ODU4TCM, ODUflex, OMS, OPTSG, OTS, OTU1, OTU1F, OTU2, OTU2E, OTU3, OTU4, PLK, PTPCLOCK, PTPPORT, RMD, RMDCESCHANNEL, RMDIF, RMDIFMAU, RMDMEP, RMDNIM, SAP, SVC, SYNC, SYNCOUT, TOD, TRU, VTS]
    severity String string Alarm severity [MJ, MN, NONE, CR, WR, NR, NA]
    defaultSeverity String string Alarm default severity [MJ, MN, NONE, CR, WR, NR, NA]
    cause String string --- ---
    locationType String string --- ---
    reported String string --- ---
    serviceAffecting String string --- ---
    alarmText String string --- ---
    uiId String string --- ---
    name String string --- ---
    value String string --- ---

    Status

    Name

    Type

    Description

    Enum

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