Operation

post /pmbin/clearpmbin
Clear pm bin on the ports (clearPmBin : /pmbin/clearpmbin)
Clearing PM bins results in resetting current PM counts,
impact historical 15m/24h data and cause any existing TCA alarms to clear
This can be performed from three places:
1. Connection level(Infrastructure,Logical Link,Service,Physical)
2. Node level-->MontioredPM Points
3. 360 tab PMEnable Points

Connection Level:Input object will contain following details:
Operation Type: 0 representing Clear PM Bin operation.
Client : 0 representing Clear PM Bin request is from Connection level.
pmBInUserInputList has following attributes:
a. Connection Type:
i. lopc - Logical Link
ii. trail - Infrastructure
iii. path - Service
iv. Doesnt match all the above it will be physical connection
b. Connection Id :
connId can be retrieved as 'id' from the REST call '/data/otn/connections'

TP Level:
Input object will contain following details:
Operation Type: 0 representing Clear PM Bin operation.
Client : 1 representing Clear PM Bin request is from 360 tab PMEnable Points.
pmBInUserInputList has following attribute :
a. neId : neId can be obtained from REST call '/data/npr/nes'
b. neName : neId can be retrieved as a guiLabel from REST call '/data/npr/nes as parameter
c. portLabel : can be retrieved as hookmapper from /data/cpm/monTps/{connId}/{client}
i. connId can be retrieved as 'id' from the REST call '/data/otn/connections'
ii. client can be any of [WDM, NPR, OPS]
To fetch portlabel from hookmappper, it has to be further split based on / and second array of string will give the protlabel.
d. monitoredRate : OS --> 20, OTS --> 30, OCH --> 230, ODU --> 900, ODU1 --> 250, ODU2 --> 245, ODU3 --> 240, ODU4 --> 236, ODU0 --> 252, ODU2E --> 243,
ODU3E2 --> 238, ODUFLEX --> 248, Gbe --> 400, 10Gbe --> 403, OC768_STS768_MS_STM256 --> 800, OC192_STS192_MS_STM64 --> 805,
OC48_STS48_MS_STM16 --> 810, OC12_STS12_MS_STM4 --> 815, OC3_STS3_MS_STM1 --> 820, OC1_STS1_MS_STM0 --> 825, Gigabit_Ethernet --> 400,
10Gigabit_Ethernet--> 403, DSR_Fast_Ethernet --> 405, ODU0TCM --> 595, ODU1TCM --> 590, ODU2TCM --> 585, ODU2eTCM --> 586, ODU3TCM --> 580,
ODU3e2TCM --> 578, ODU4TCM --> 575, OTU2E --> 242, OTU3E2 --> 233, OTU4HalfX5 --> 231, OTU4X2 --> 232, OTU4 --> 234, OTU1F --> 246,
ODU1F --> 247, OTL4_4 --> 241, OTU4Half --> 251, OTU4_OCH --> 299 and DSR --> 200
e. emlMapper : Its a SNA instance where NE is managed.
f. granularity : 1 Day or 15 Minutes
g. pmGroup : Ethernet, SDH/SONET, OPIN, OPT, OPR, OPOCHOUT, INF, OPOCHIN, preFECBER, OPOUT, DW, CDR, DGDR, FEC, PCS, FOFFR, E1, TCM, OTU, ODURX, ODUTX and ETHFEC

Node level:
Input object will contain following details:
Operation Type: 0 representing Clear PM Bin operation.
Client : 2 representing Clear PM Bin request is from Node level-->MontioredPM Points.
pmBInUserInputList has following attribute :
a. neName : neId can be retrieved as a guiLabel from REST call '/data/npr/nes as parameter
b. portLabel : can be retrieved as hookmapper from /data/cpm/monTps/{connId}/{client}
i. connId can be retrieved as 'id' from the REST call '/data/otn/connections'
ii. client can be any of [WDM, NPR, OPS]
c. effectiveRate : Similar as layer rate.
d. monitoredRate : OS --> 20, OTS --> 30, OCH --> 230, ODU --> 900, ODU1 --> 250, ODU2 --> 245, ODU3 --> 240, ODU4 --> 236, ODU0 --> 252, ODU2E --> 243,
ODU3E2 --> 238, ODUFLEX --> 248, Gbe --> 400, 10Gbe --> 403, OC768_STS768_MS_STM256 --> 800, OC192_STS192_MS_STM64 --> 805,
OC48_STS48_MS_STM16 --> 810, OC12_STS12_MS_STM4 --> 815, OC3_STS3_MS_STM1 --> 820, OC1_STS1_MS_STM0 --> 825, Gigabit_Ethernet --> 400,
10Gigabit_Ethernet--> 403, DSR_Fast_Ethernet --> 405, ODU0TCM --> 595, ODU1TCM --> 590, ODU2TCM --> 585, ODU2eTCM --> 586, ODU3TCM --> 580,
ODU3e2TCM --> 578, ODU4TCM --> 575, OTU2E --> 242, OTU3E2 --> 233, OTU4HalfX5 --> 231, OTU4X2 --> 232, OTU4 --> 234, OTU1F --> 246,
ODU1F --> 247, OTL4_4 --> 241, OTU4Half --> 251, OTU4_OCH --> 299 and DSR --> 200
e. granularity : 1 Day or 15 Minutes
f. pmGroup : Ethernet, SDH/SONET, OPIN, OPT, OPR, OPOCHOUT, INF, OPOCHIN, preFECBER, OPOUT, DW, CDR, DGDR, FEC, PCS, FOFFR, E1, TCM, OTU, ODURX, ODUTX and ETHFEC

Request body

Name

IsRequired

Description

Data Type

Enum

body optional session HttpSession ---
body2 required pmBinUserInputData String ---

Return type
  • ClearPmBinResponse
  • Responses

    Response Messages

    Schema

    200success ClearPmBinResponse
    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

    Request Payload at connection level { "operType":0, "client":0, "pmBInUserInputList":[ { "connId":"238", "connType":"Service" } ] } Request Payload at pmtp level { "operType":0, "client":"1", "pmBInUserInputList":[ { "neId":"581", "neName":"SVT-RING1-COMP-3", "portLabel":"11QPA4-5-2-C1", "monitoredRate":200, "emlMapper":101, "granularity":"1 Day", "pmGroup":[ "Ethernet" ] } ] } Request Payload at node level { "operType":0, "client":"2", "pmBInUserInputList":[ { "neName":"PSI-2T-NE12", "portLabel":"LCI2000-1-2-L1", "effectiveRate":"OTU4X2", "monitoredRate":"20", "granularity":"15 Minutes", "pmGroup":[ "OPT" ] } ] }

    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
    { "statusCode":4, "message":"SUCCESS", "responseObject":null }

    External Docs
    See Also :

    ClearPmBinResponse

    Name

    Type

    Description

    Enum

    statusCode Integer integer Specifies the status of the request---Example:200 for success ---
    message String string Specifies the response message if any, for the request---Example:Scan scheduled successfully. ---
    responseObject Object object Specifies the response object for the request ---