Operation

post /sdh-report-controller/data/cpm/archiveOper/{sessionID}
Archives the session selected by the user in archive session window (archiveOper : /sdh-report-controller/data/cpm/archiveOper/{sessionID})
The PM data meeting the Granularity defined, and occurring between the start and end times specified, is archived.
The archive session is refreshed to display the archive time, and a newsession is generated.
UI navigation link :
1.Click on Administer
2.Select PM Archive Sessions from the list view
3.Select one of the archive session
4.click on Archive button from the menu buttons present at top right corner

Path parameters

Name

IsRequired

Description

Enum

sessionID required 'sessionId' can be retrieved as 'id' from the rest call /data/cpm/archiveSessions ---
Request body

Name

IsRequired

Description

Data Type

Enum

body required archOper ArchiveOperationDto ---

Return type
  • ArchiveOperationDto
  • Responses

    Response Messages

    Schema

    200success ArchiveOperationDto
    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
    Tags
    [ PM]

    External Docs
    See Also :
  • getAllArchiveSessions : /data/cpm/archiveSessions

  • Operation

    post /sdh-report-controller/consistpm
    This operation allows to force the alignment of PM, forcing the repetition of all start/stop commands over all known Termination points, independently on the fact they are already consistent or not.To make an inconsistent pmtp consistent. (consistPM : /sdh-report-controller/consistpm)
    After the activation of the pmtp, if the pmtp is marked as 'consistent', this means
    that the activation command has been successfully completed for all the correlated points.
    This means that the NEs have started the monitoring action and the EMLs will provide
    the required data.
    UI navigation link :
    1.Click on Operate
    2.Click on one of the pm enabled connection(Physical,Infrastructure,Services)
    3.Click Pm Enabled Points tab on 360 degree tab view
    4.Select one PMTP
    5.Click Align PM from the menu buttons

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required pminput PMReportUserInput ---

    Return type
  • JqgridResponse
  • Responses

    Response Messages

    Schema

    200success JqgridResponse
    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 /sdh-report-controller/correlate
    Correlates the pmtp with tca profile (correlatePmtp : /sdh-report-controller/correlate)
    Correlates the pmtp with tca profile available for correlation.
    The available tca profiles can be seen on pm enable points if pm is
    enabled for that pmtp on infrastructure connection or services
    UI navigation link :
    1.Click on Operate
    2.Click on one of the pm enabled connection(Physical,Infrastructure,Services)
    3.Click Pm Enabled Points tab on 360 degree view
    4.Select one PMTP
    5.Click Correlate TCA from the menu buttons

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required pminput PMReportUserInput ---

    Return type
  • JqgridResponse
  • Responses

    Response Messages

    Schema

    200success JqgridResponse
    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 /sdh-report-controller/corrOrUncorrReportProfile
    correlate or uncorrelate the report profile to connection (correlateReportProfileToConn : /sdh-report-controller/corrOrUncorrReportProfile)
    Correlate or uncorrelate the available report profile to connection
    The connection can be:
    1.Infrastructure connection
    2.Services
    UI Navigation link:
    1.Click on Operate
    2.Right Click on one of the pm enabled connection(Physical,Infrastructure,Services)
    3.Click on Report Profile Association from the list view

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required pminput PMReportUserInput ---

    Return type
  • JqgridResponse
  • Responses

    Response Messages

    Schema

    200success JqgridResponse
    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 /sdh-report-controller/data/cpm/archiveRules
    Archive Rules (getAllArchiveRules : /sdh-report-controller/data/cpm/archiveRules)
    List archive rules based on domain,granularity,period,archive delay and delete delay.

    Possible values for the attributes used in defining the rule:
    domain : ANALOG , ETH , MPLS , SDH
    granularity : 15 min , hour , day
    period : Day ,1 Week , 2 Weeks , Month , Quarter , Half Year , Year
    UI Navigation link:
    1.Click on Administer
    2.Select PM Archive Rules from the list view


    Return type
  • ArchiveRuleDto
  • Responses

    Response Messages

    Schema

    200success ArchiveRuleDto
    401Unauthorized ---
    303Session ended Void
    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 /sdh-report-controller/data/cpm/archiveSessions
    Archive Sessions (getAllArchiveSessions : /sdh-report-controller/data/cpm/archiveSessions)
    Shows archive sessions view where domain,granularity,start time ,end time ,archived time ,retrieval time and deleted time are shown.

    There are three operations defined for archive sessions
    1. archive
    2. retrieve
    3. purge(delete)

    Possible values for the attributes used in the archive sessions:
    domain : ANALOG , ETH , MPLS , SDH
    granularity : 15 min , hour , day
    instanceName : EML_1-13, ANALOG13_1, ETH13_1
    UI navigation link :
    1.Click on Administer
    2.Select PM Archive Sessions from the list view


    Return type
  • ArchiveSessionsDto
  • Responses

    Response Messages

    Schema

    200success ArchiveSessionsDto
    401Unauthorized ---
    303Session ended Void
    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 /sdh-report-controller/maxArchiveSessions
    Maximum archive sessions (getAllMaxArchiveSessions : /sdh-report-controller/maxArchiveSessions)
    Internal rest call which fetches the maximum archive sessions from db


    Return type
  • ArchiveSessionsDto
  • Responses

    Response Messages

    Schema

    200success ArchiveSessionsDto
    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 /sdh-report-controller/data/cpm/getReportProfileGridView/{id}
    Lists Report Profiles (getAllReportProfile : /sdh-report-controller/data/cpm/getReportProfileGridView/{id})
    List NML Report Profiles for PM.
    UI navigation link :
    1.Click Design-->PM Templates
    2.Click on My Profiles
    3.Select Report Profile from the tree

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • Report
  • Responses

    Response Messages

    Schema

    200success Report
    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 /sdh-report-controller/data/cpm/getReportProfileGridView
    Lists Report Profiles (getAllReportProfiles : /sdh-report-controller/data/cpm/getReportProfileGridView)
    List NML Report Profiles for PM.
    UI navigation link :
    1.Click Design-->PM Templates
    2.Click on My Profiles
    3.Select Report Profile from the tree


    Return type
  • Report
  • Responses

    Response Messages

    Schema

    200success Report
    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 /sdh-report-controller/data/cpm/getTcaProfileGridView/{id}
    Lists TCA Profiles (getAllTCAProfile : /sdh-report-controller/data/cpm/getTcaProfileGridView/{id})
    Lists all threshold crossing alarm profiles
    UI navigation link :
    1.Click Design-->PM Templates
    2.Click on My Profiles
    3.Select TCA Profile from the tree

    Path parameters

    Name

    IsRequired

    Description

    Enum

    id required id ---

    Return type
  • tcaDto
  • Responses

    Response Messages

    Schema

    200success tcaDto
    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 /sdh-report-controller/data/cpm/getTcaProfileGridView
    Lists TCA Profiles (getAllTCAProfiles : /sdh-report-controller/data/cpm/getTcaProfileGridView)
    Lists all threshold crossing alarm profiles
    UI navigation link :
    1.Click Design-->PM Templates
    2.Click on My Profiles
    3.Select TCA Profile from the tree


    Return type
  • tcaDto
  • Responses

    Response Messages

    Schema

    200success tcaDto
    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 /sdh-report-controller/asapDetails
    getAsapDetails (getAsapDetails : /sdh-report-controller/asapDetails)
    getAsapDetails


    Return type
  • JqgridResponse«ReportProfilesDto»
  • Responses

    Response Messages

    Schema

    200success JqgridResponse«ReportProfilesDto»
    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 /sdh-report-controller/data/cpm/getAvailReportProfiles/{operationType}/{connId}/{gran}/{client}
    Lists Report Profiles (getAvailableReportProfiles : /sdh-report-controller/data/cpm/getAvailReportProfiles/{operationType}/{connId}/{gran}/{client})
    Lists the report profiles available for correlation based on operation type , granularity and connection id and report window
    Report window must be a multiple of the granularity.

    operation type : 0 for hystory PM , 1 for Current PM , 2 for get Available TCA Profiles, 3 for get Available Report Profiles
    granularity : '1' for 15 minutes, '0' for 24 hour
    report window :15 mins , 1 hour , 2 hours , 24 hours , 1 week , 1 month
    UI Navigation link:
    1.Click on Operate
    2.Click on one of the pm enabled connection(Physical,Infrastructure,Services)
    3.Select Report Profile Association from list view
    4.Select the granularity for the correlation in the Report Profile Association window

    Path parameters

    Name

    IsRequired

    Description

    Enum

    operationType required operationType [3]
    connId required connId can be obtained from '/data/otn/connections' REST call as id ---
    gran required gran [0, 1]
    client required client [OTN, NPR, OPS]

    Return type
  • ReportProfilesDto
  • Responses

    Response Messages

    Schema

    200success ReportProfilesDto
    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
    [ PM ]

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /sdh-report-controller/getAvailReportProfiles
    get AvailableReport Profiles For Eqm (getAvailableReportProfilesForEqm : /sdh-report-controller/getAvailReportProfiles)
    Lists all the available report profiles for eqm,'operType=3' for get Available Report Profiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required pminput PMReportUserInput ---

    Return type
  • ReportProfilesDto
  • Responses

    Response Messages

    Schema

    200success ReportProfilesDto
    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 /sdh-report-controller/getAvailProfiles
    getAvailableTCAProfiles (getAvailableTCAProfiles : /sdh-report-controller/getAvailProfiles)
    getAvailableTCAProfiles

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional pminput PMReportUserInput ---

    Return type
  • JqgridResponse
  • Responses

    Response Messages

    Schema

    200success JqgridResponse
    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 /sdh-report-controller/data/cpm/getAvailTcaProfiles/{xosDir}/{reqDirection}/{granStr}/{monitoredRate}/{pmLayerRate}/{isPsdEth}
    Get available TCA Profiles (getAvailableTCAProfilesFromOtnFwk : /sdh-report-controller/data/cpm/getAvailTcaProfiles/{xosDir}/{reqDirection}/{granStr}/{monitoredRate}/{pmLayerRate}/{isPsdEth})
    Lists all the tca profiles available for correlation
    This correlation could be seen on pm enable points on :
    1. Physical connections
    2. Infrastructure connections
    3. Services
    UI Navigation Link:
    1.Click on Operate
    2.Click on one of the pm enabled connection(Physical,Infrastructure,Services)
    3.Click Pm Enabled Points tab on 360 degree view
    4.Select one PMTP
    5.Click Correlate TCA from the menu buttons

    Path parameters

    Name

    IsRequired

    Description

    Enum

    xosDir required xosDir [5, 6]
    reqDirection required reqDirection [1, 2]
    granStr required granStr [15Minutes, 24Hour]
    monitoredRate required monitoredRate [2, 17, 3, 23, 15, 24, 19, 20, 6, 5, 21, 4, 22, 18, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36]
    pmLayerRate required pmLayerRate [17, 1, 31, 8, 0, 32, 5, 6, 35, 37, 25, 19, 20, 21, 22, 23, 11, 12, 2, 3, 4, 29, 14, 24, 26, 28, 30, 41, 42, 39, 38]
    isPsdEth required isPsdEth ---

    Return type
  • NmlTcaProfile
  • Responses

    Response Messages

    Schema

    200success NmlTcaProfile
    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 /sdh-report-controller/getEsmMclagDetails
    Gets all the mclag details. (getEsmMclagDetails : /sdh-report-controller/getEsmMclagDetails)
    Fetches all the mclag details like peerId,sourceId,identifier and operation status
    UI Navigation link :
    1.Click on Operate
    2.Click Ethernet Service Manager
    3.Click on Operate in Ethernet Service Manager window
    4.Select MC-LAG
    5.Select Details tab

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required pminput PMReportUserInput ---

    Return type
  • JqgridResponse
  • Responses

    Response Messages

    Schema

    200success JqgridResponse
    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 /sdh-report-controller/getEsmOamTestDetails
    /getEsmOamTestDetails (getEsmOamTestDetails : /sdh-report-controller/getEsmOamTestDetails)
    Tells the details for the carrier ethernet oam
    UI Navigation link :
    1.Click on Operate
    2.Click Ethernet Service Manager
    3.Click on Operate in Ethernet Service Manager window
    4.Select Carrier Ethernet OAM
    5.Select Details tab

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional pminput PMReportUserInput ---

    Return type
  • JqgridResponse
  • Responses

    Response Messages

    Schema

    200success JqgridResponse
    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 /sdh-report-controller/getMaxNodeRowsForPmPoints
    Lists Report Profiles (getMaxNodeRowsForPmPoints : /sdh-report-controller/getMaxNodeRowsForPmPoints)
    List NML Report Profiles for PM.
    UI navigation link :
    1.Click Design-->PM Templates
    2.Click on My Profiles
    3.Select Report Profile from the tree


    Return type
  • Report
  • Responses

    Response Messages

    Schema

    200success Report
    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 /sdh-report-controller/data/cpm/monTps/{connId}/{client}
    Pm enable points (getMonitoredTpsOfConnFromOtnFrmWork : /sdh-report-controller/data/cpm/monTps/{connId}/{client})
    Fetch monitored tps of connection from otn framework,'0' for 1 day granularity and '1' for 15 min granularity
    UI navigation link :
    1.Click on Operate
    2.Click on one of the pm enabled connection(Physical,Infrastructure,Services)
    3.Click Pm Enabled Points tab on 360 degree view

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId can be retrieved as 'id' from the REST call '/data/otn/connections' ---
    client required client [WDM, NPR, OPS]

    Return type
  • MonitoredTPsDto
  • Responses

    Response Messages

    Schema

    200success MonitoredTPsDto
    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
    [ PM]

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    get /sdh-report-controller/data/cpm/monTpsSDHCPM/{connId}/{transpType}
    Pm enable points (getMonitoredTpsOfConnFromOtnFrmWork : /sdh-report-controller/data/cpm/monTpsSDHCPM/{connId}/{transpType})
    Fetch monitored tps of connection from otn framework,'0' for 1 day granularity and '1' for 15 min granularity
    UI navigation link :
    1.Click on Operate
    2.Click on one of the pm enabled connection(Physical,Infrastructure,Services)
    3.Click Pm Enabled Points tab on 360 degree view

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId can be retrieved as 'id' of connection identifier ' ---
    transpType required connId can be retrieved as 'transpType' of the selected connection' ---
    Query parameters

    Name

    IsRequired

    Description

    connectionName optional ---

    Return type
  • MonitoredTPsDtoExt
  • Responses

    Response Messages

    Schema

    200success MonitoredTPsDtoExt
    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
    [ PM]

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /sdh-report-controller/monitoredtps
    getMonitoredTpsOfConnection (getMonitoredTpsOfConnection : /sdh-report-controller/monitoredtps)
    getMonitoredTpsOfConnection

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional pminput PMReportUserInput ---

    Return type
  • JqgridResponse«MonitoredTPsDto»
  • Responses

    Response Messages

    Schema

    200success JqgridResponse«MonitoredTPsDto»
    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 /sdh-report-controller/getNextChart
    SDH getNextChart (getNextChart : /sdh-report-controller/getNextChart)
    Retrieves the next session for the pmdata. By default chart format is enabled
    for pmreport for connecton level and pmtp level./getNextChart is called while generating report on
    connectionlevel and pmtp level.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required pminput PMReportUserInput ---

    Return type
  • JqgridResponse
  • Responses

    Response Messages

    Schema

    200success JqgridResponse
    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 /sdh-report-controller/getEsmTpsOfService
    Lists esm tps of service (getTpsOfESMService : /sdh-report-controller/getEsmTpsOfService)
    List all the tps of esm service
    UI navigation link :
    1.Click on Operate
    2.Click Ethernet Service Manager
    3.Click on Operate-->Services
    4.Select PM Report button from menu buttons
    5.Select current PM from pm report window

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required pminput PMReportUserInput ---

    Return type
  • JqgridResponse
  • Responses

    Response Messages

    Schema

    200success JqgridResponse
    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 /sdh-report-controller/locale
    /locale (locale : /sdh-report-controller/locale)
    Tells the user which locale he belongs to and download the i18 mappings according to the locale


    Return type
  • JqgridResponse
  • Responses

    Response Messages

    Schema

    200success JqgridResponse
    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 /sdh-report-controller/connection/{connId}/showPm
    method (method : /sdh-report-controller/connection/{connId}/showPm)
    method

    Path parameters

    Name

    IsRequired

    Description

    Enum

    connId required connId ---

    Return type
  • ModelAndView
  • Responses

    Response Messages

    Schema

    200success ModelAndView
    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 :

    Operation

    post /sdh-report-controller/pmdataforconns
    SDH Pm report at Connection level (pmDataForConnections : /sdh-report-controller/pmdataforconns)
    Selects tp based on connection id from the DB and generates pm report for those tps
    Connection level pm report can be generated on following connections:
    1. Physical connections
    2. Infrastructure connections
    3. Services
    UI navigation link:
    1.Click on Operate
    2.Click on one of the pm enabled connection(Physical,Infrastructure,Services)
    3.Select PM Report from list view

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required pminput PMReportUserInput ---

    Return type
  • JasperDto
  • Responses

    Response Messages

    Schema

    200success JasperDto
    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 /sdh-report-controller/pmdata
    Pm Report at pmtp level (pmDataForTps : /sdh-report-controller/pmdata)
    Generates the PM Report based on selected tps by user.
    Pmtp level pm report can be generated on following connections:
    1. Physical connections
    2. Infrastructure connections
    3. Services
    Two types of pm report can be genearated:
    1. 15min granularity pm report
    2. 24 hour granularity pm report
    UI navigation link:
    1.Click on Operate
    2.Click on one of the pm enabled connection(Physical,Infrastructure,Services)
    3.Click Pm Enabled Points tab on 360 degree view
    4.Select one PMTP
    5.Click CurrentPm or HistoryPm from the menu buttonsExport File Location: /opt/hpws/tomcat/webapps/oms1350/web/cpm/report

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required pminput PMReportUserInput ---

    Return type
  • JasperDto
  • Responses

    Response Messages

    Schema

    200success JasperDto
    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 /sdh-report-controller/pmdata/tpids
    Pm Report at pmtp level (pmDataForTpsByTpIds : /sdh-report-controller/pmdata/tpids)
    Generates the PM Report based on TP Ids provided by user.
    TP Ids are pmtptids, seperated by caret '^'
    This rest call is only applicable for testing.

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required pminput PMReportUserInput ---

    Return type
  • JasperDto
  • Responses

    Response Messages

    Schema

    200success JasperDto
    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 /sdh-report-controller/showpmtps
    pmTpsOfNE (pmTpsOfNE : /sdh-report-controller/showpmtps)
    pmTpsOfNE

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body optional pminput PMReportUserInput ---

    Return type
  • DeferredResult«JqgridResponse«PMTpDto»»
  • Responses

    Response Messages

    Schema

    200success DeferredResult«JqgridResponse«PMTpDto»»
    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 /sdh-report-controller/data/cpm/showpmtps/{neGroupId}/{emlNeId}/{tpPortLabel}/{reqGranularity}/{cltTz}
    Show Pmtps (pmTpsOfNEFromNavRouterByPortLabel : /sdh-report-controller/data/cpm/showpmtps/{neGroupId}/{emlNeId}/{tpPortLabel}/{reqGranularity}/{cltTz})
    List all monitored tps for the selected node in nezic
    UI Navigation Link :
    1.Click Operate-->Equipment manager
    2.Select one of the NE from the left side tree
    3.Click NE WEBUI button
    4.click on Performance tab
    5.Select PM Report tab
    5.Select Granularity and click on Retrieve

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neGroupId required The 'neGroupId' can be obtained as 'emlDomId' from /data/npr/nes ---
    emlNeId required The 'emlNeId' can be obtained as 'emlNeId' from /data/npr/nes ---
    tpPortLabel required The 'tpPortLabel' can be obtained as 'tpPortLabel' from /data/npr/nes ---
    reqGranularity required The 'reqGranularity' can be obtained as 'reqGranularity' from /data/npr/nes ---
    cltTz required cltTz [330, -330]

    Return type
  • PMTpDto
  • Responses

    Response Messages

    Schema

    200success PMTpDto
    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
    [ PM]

    External Docs
    See Also :
  • returnNePostController : /data/npr/nes

  • Operation

    get /sdh-report-controller/data/cpm/nepmtps/{neName}/{startTime}/{endTime}/{gran}/{cltTz}
    Show NE PM Report (pmTpsOfNEFromOtnFrmWork : /sdh-report-controller/data/cpm/nepmtps/{neName}/{startTime}/{endTime}/{gran}/{cltTz})
    PM Reports for the selected node/NE

    Path parameters

    Name

    IsRequired

    Description

    Enum

    neName required neName ---
    cltTz required cltTz ---
    startTime required startTime ---
    endTime required endTime ---
    gran required gran ---

    Return type
  • PMTpDto
  • Responses

    Response Messages

    Schema

    200success PMTpDto
    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 /sdh-report-controller/data/cpm/showpmtps/{nodeId}/{neId}/{cltTz}
    Show Pmtps (pmTpsOfNEFromOtnFrmWork : /sdh-report-controller/data/cpm/showpmtps/{nodeId}/{neId}/{cltTz})
    List all monitored tps for the selected node UI Navigation link:
    1.Click on Operate
    2.Click on Node
    3.Right click on one of the node and select PM from list view
    4.Select Monitored Points

    Path parameters

    Name

    IsRequired

    Description

    Enum

    nodeId required 'nodeId' can be obtained from '/data/npr/nes' REST call as 'associatedNodeId' ---
    neId required 'neId' can be obtained from '/data/npr/nes' REST call as 'associatedNeId' ---
    cltTz required cltTz [330, -330]

    Return type
  • PMTpDto
  • Responses

    Response Messages

    Schema

    200success PMTpDto
    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
    [ PM]

    External Docs
    See Also :
  • networkConnectionsByIdInRequestBody : /data/otn/connections

  • Operation

    post /sdh-report-controller/stopOnGoingReq
    Stops the ongoing request (stopOnGoingReq : /sdh-report-controller/stopOnGoingReq)
    Stops the collection for esm current pm before the specified no. of polling frequency
    UI Navigation link:
    1.Click on Operate
    2.Click Ethernet Service Manager
    3.Click on Operate-->Services
    4.Select PM Report button from menu buttons
    5.Select current PM from pm report window
    6.Select the polling interval,polling frequency,pmgroup and supported counters
    7.Generate tabular pm report.
    8.Click on stop button if the polling frequency is greater than 1

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required pminput PMReportUserInput ---

    Return type
  • JqgridResponse
  • Responses

    Response Messages

    Schema

    200success JqgridResponse
    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 /sdh-report-controller/uncorrelate
    Uncorrelates the pmtp with tca profile (uncorrelatePmtp : /sdh-report-controller/uncorrelate)
    Uncorrelates the pmtp with tca profile.
    UI Navigation link :
    1.Click on Operate
    2.Click on one of the pm enabled connection(Physical,Infrastructure,Services)
    3.Click Pm Enabled Points tab on 360 degree view
    4.Select one PMTP which is correlated
    5.Click Uncorrelate button from the menu buttons

    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required pminput PMReportUserInput ---

    Return type
  • JqgridResponse
  • Responses

    Response Messages

    Schema

    200success JqgridResponse
    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 /sdh-report-controller/data/cpm/archiveRules/{ruleId}
    Updates archive rule (updateArchiveRule : /sdh-report-controller/data/cpm/archiveRules/{ruleId})
    Modifies the archive rule based on values given by the user for the parameters involved in the archive rule
    UI Navigation link:
    1.Click on Administer
    2.Select PM Archive Rules from the list view
    3.Click on Modify Rule button
    4.Update any attribute like archive delay
    5.Click on save

    Path parameters

    Name

    IsRequired

    Description

    Enum

    ruleId required 'ruleId' can be retrieved as 'ruleId' from the rest call /data/cpm/archiveRules ---
    Request body

    Name

    IsRequired

    Description

    Data Type

    Enum

    body required archRule ArchiveRuleDto ---

    Return type
  • ArchiveSessionsDto
  • Responses

    Response Messages

    Schema

    200success ArchiveSessionsDto
    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
    Tags
    [ PM]

    External Docs
    See Also :
  • getAllArchiveRules : /data/cpm/archiveRules

  • ArchiveOperationDto

    Name

    Type

    Description

    Enum

    fileName String string --- ---
    instanceName String string --- ---
    eml String string --- ---
    gran String string --- ---
    sessionType Integer integer --- ---
    retrieve Boolean boolean --- ---
    startTime String string --- ---
    sessionId Integer integer --- ---
    endTime String string --- ---
    commandMode String string --- ---

    ArchiveRuleDto

    Name

    Type

    Description

    Enum

    domain String string --- ---
    instanceName String string --- ---
    db String string --- ---
    granularity String string --- ---
    autoMode String string --- ---
    period String string --- ---
    archiveDelay Integer integer --- ---
    deleteDelay Integer integer --- ---
    ruleId String string --- ---
    user String string --- ---
    id Integer integer --- ---

    ArchiveSessionsDto

    Name

    Type

    Description

    Enum

    domain String string --- ---
    instanceName String string --- ---
    db String string --- ---
    number String string --- ---
    granularity String string --- ---
    startTime String string --- ---
    endTime String string --- ---
    archiveTime String string --- ---
    deleteTime String string --- ---
    retrieveTime String string --- ---
    archiveFailrea String string --- ---
    pmDomId String string --- ---
    deletionSucess String string --- ---
    userLable String string --- ---
    deletionFailrea String string --- ---
    archiveSucess String string --- ---
    ruleId String string --- ---
    id Integer integer --- ---
    count String string --- ---

    DeferredResult«JqgridResponse«PMTpDto»»

    Name

    Type

    Description

    Enum

    result Object object --- ---
    setOrExpired Boolean boolean --- ---

    HashMap«string,string»

    Name

    Type

    Description

    Enum

    JasperDto

    Name

    Type

    Description

    Enum

    timestamp String string --- ---
    tpLabel String string --- ---
    status Integer integer --- ---
    granularity Integer integer --- ---
    neLabel String string --- ---
    id String string --- ---
    connName String string --- ---
    location String string --- ---
    direction String string --- ---
    layerRate String string --- ---
    hookmapper String string --- ---
    connId String string --- ---
    pmData HashMap«string,string» HashMap«string,string» --- ---
    groupName String string --- ---

    JqgridResponse

    Name

    Type

    Description

    Enum

    identifier String string --- ---
    items array[Serializable] Serializable --- ---
    colnames String string --- ---
    status String string --- ---
    operTime String string --- ---
    warningMessage String string --- ---

    JqgridResponse«MonitoredTPsDto»

    Name

    Type

    Description

    Enum

    identifier String string --- ---
    items array[MonitoredTPsDto] MonitoredTPsDto --- ---
    colnames String string --- ---
    status String string --- ---
    operTime String string --- ---
    warningMessage String string --- ---

    JqgridResponse«PMTpDto»

    Name

    Type

    Description

    Enum

    identifier String string --- ---
    items array[PMTpDto] PMTpDto --- ---
    colnames String string --- ---
    status String string --- ---
    operTime String string --- ---
    warningMessage String string --- ---

    JqgridResponse«ReportProfilesDto»

    Name

    Type

    Description

    Enum

    identifier String string --- ---
    items array[ReportProfilesDto] ReportProfilesDto --- ---
    colnames String string --- ---
    status String string --- ---
    operTime String string --- ---
    warningMessage String string --- ---

    ModelAndView

    Name

    Type

    Description

    Enum

    view View View --- ---
    model Object object --- ---
    status String string --- [100, 101, 102, 103, 200, 201, 202, 203, 204, 205, 206, 207, 208, 226, 300, 301, 302, 302, 303, 304, 305, 307, 308, 400, 401, 402, 403, 404, 405, 406, 407, 408, 409, 410, 411, 412, 413, 413, 414, 414, 415, 416, 417, 418, 419, 420, 421, 422, 423, 424, 426, 428, 429, 431, 451, 500, 501, 502, 503, 504, 505, 506, 507, 508, 509, 510, 511]
    viewName String string --- ---
    reference Boolean boolean --- ---
    modelMap ModelMap ModelMap --- ---
    empty Boolean boolean --- ---

    ModelMap

    Name

    Type

    Description

    Enum

    empty Boolean boolean --- ---

    MonitoredTPsDto

    Name

    Type

    Description

    Enum

    tpLabel String string returns tpLabel ---
    hookmapper String string return the hookmapper ---
    location String string returns location [NEND , FEND]
    direction String string returns direction [RCV , TRMT ]
    tpUserlabel String string returns tp user label ---
    pmStatus String string returns pmStatus [started , stopped , start_failed , stop_failed]
    granularity Integer integer returns granularity,'0' for 1 day and '1' for 15 min ---
    neLabel String string returns ne label ---
    id String string returns the tp id ---
    tcaLabel String string --- ---
    neTca String string --- ---
    groupName String string returns group name [OPIN , OPOUT , OPOCHIN , CDR , DGDR , FOFFR , PreFECBits , OSNR]
    pmconsistency Integer integer pmconsistency ---
    emlMapper Integer integer eml sna id ---
    fdnMapper String string fully distinguished name for tp ---
    portLabel String string return port label ---
    tptype String string returns tptype ---
    xosDir Integer integer xosDirection ---
    reqDirection String string return required direction value [5 , 6]
    monitoredRate Integer integer monitored rate ---
    pmLayerRate Integer integer return pm layer rate ---
    signalType Integer integer signal type ---
    bitrate String string bitrate ---
    fectype String string fectype ---
    neName String string returns OCS or PHN ne name ---
    granStr String string returns granularity string [15 Minutes , 1 Day]
    monitoredRateStr String string returns monitored rate string ---
    technology String string returns technology, 'Analog' or 'Digital' ---

    MonitoredTPsDtoExt

    Name

    Type

    Description

    Enum

    userabel String string --- ---
    type String string --- ---
    status Integer integer --- ---
    collPeriod String string --- ---
    id String string --- ---
    neLabel String string --- ---
    supportedCounters String string --- ---
    tpLabel String string --- ---
    location String string --- ---
    direction String string --- ---
    granularity String string --- ---
    groupName String string --- ---
    statusStr String string --- ---
    cnt String string --- ---
    layerRate String string --- ---
    pmTranspType String string --- ---
    nodeName String string --- ---
    pmStartDate String string --- ---
    pmEndDate String string --- ---
    hookmapper String string --- ---
    requiredRole String string --- ---
    tpUserlabel String string --- ---
    pmStatus String string --- ---
    tcaLabel String string --- ---
    neTca String string --- ---
    pmconsistency Integer integer --- ---
    emlMapper Integer integer --- ---
    fdnMapper String string --- ---
    portLabel String string --- ---
    tptype String string --- ---
    xosDir Integer integer --- ---
    reqDirection String string --- ---
    monitoredRate Integer integer --- ---
    pmLayerRate Integer integer --- ---
    signalType Integer integer --- ---
    bitrate String string --- ---
    fectype String string --- ---
    neName String string --- ---
    monitoredRateStr String string --- ---
    technology String string --- ---
    system String string --- ---
    connectionName String string --- ---
    pmTranspTypeCode Integer integer --- ---
    transpId Integer integer --- ---

    NmlTcaProfile

    Name

    Type

    Description

    Enum

    id String string returns id ---
    profId String string returns profile id ---
    tcaLabel String string returns the tca label ---

    PMReportUserInput

    Name

    Type

    Description

    Enum

    selectedEntities String string returns connection id. Note: if its value = 0 then not used and return as part of selectedEntities. Values for connections - connection ids separated by comma and for TP - Hookmappers seperated by ^. Its a mandatory field [1, 2]
    fromTime String string Start Time for PM Report. Format Ex: '2018-12-16-15:52' or ''(Empty string). Its a mandatory field [2018-12-16-15:52]
    endTime String string End Time for PM Report generated. Format Ex: '2018-12-16-15:52' or ''(Empty string) [2018-12-16-15:52]
    granularity String string returns granularity,'24Hr' for 1 day and '15min' for 15 minutes PM Report. Its a mandatory field and Enum type may differ based upon the operations [24Hr, 15min]
    clientTz String string client time zone depends on the location of the user. Generally clientTz= UTC+Offset or UTC-Offset. Offset is timezone value in minutes. For example, IST with +5.30GMT, clientTz=0-330=-330. Its a mandatory field [-330]
    expFormat String string returns PM Report export format. For example: Tabular : ''(empty string),Line chart: 'LINE', Bar chart: 'BAR', CSV : 'CSV',HTML : 'HTML',PDF : 'PDF'. Its a mandatory field [ ' '(empty string), LINE, BAR, CSV, HTML, PDF]
    emlMapper Integer integer eml sna id ---
    fdnMapper String string Fully distinguished name for tp ---
    portLabel String string returns portLabel for the selected Termination Points associated to Connectivities. [OTU-1-11-1]
    tptype Integer integer returns Type for Termination Points based upon Granularity ---
    xosDir Integer integer returns xosDirection for the Selected Termination Points ---
    reqDirection Integer integer returns Request direction for Termination Points associated to Connectivities. ---
    monitoredRate Integer integer returns Monitored rate based upon respective Termination Points. ---
    pmLayerRate Integer integer returns Pm layer rate based upon respective Termination Points. [19]
    operationType Integer integer 0 for History PM , 1 for Current PM , 2 for get Available Profiles,3 for correlate Pmtp, 4 for uncorrelate pmtp, 5 for Consist PM [0]
    neName String string returns NE name to associated Connectivities [11DPM12-1-4-L1-1]
    measId String string This corresponds to either 15min or 24hrs measure of associated Connectivities.). [1]
    tpId Long long returns Termination Points id for the selected Termination Point ---
    tpIds String string returns list of Termination Point Ids ---
    profId Long long returns selected TCA profile Id ---
    repId String string returns report id ---
    connId String string returns as connection type to associated Connectivities. -1 for Physical connection and 0 for both Infra connection and Service Connection. Its a mandatory field [0, -1]
    databasetype String string databasetype ---
    userLabel String string returns Transp User Label ---
    transpType String string returns Transp Type Enum ---
    pmTpType String string --- ---
    cpmtpIds String string List of CPMTP.ID This information is used to select the specific Monitored points identification to require the History PM pr the specipic termination point. ---

    PMTpDto

    Name

    Type

    Description

    Enum

    userabel String string --- ---
    type String string --- ---
    status Integer integer --- ---
    collPeriod String string --- ---
    id String string --- ---
    neLabel String string --- ---
    supportedCounters String string --- ---
    tpLabel String string --- ---
    location String string --- ---
    direction String string --- ---
    granularity String string --- ---
    groupName String string --- ---
    statusStr String string --- ---
    cnt String string --- ---
    layerRate String string --- ---

    Report

    Name

    Type

    Description

    Enum

    USERLABEL String string --- ---
    PMREPORTFORMAT String string --- ---
    CSVREPOSITORY String string --- ---
    PMREPORTWINDOW String string --- ---
    PMREPORTDESTTYPE String string --- ---
    PMREPDESTNAME String string --- ---
    SECURITYLABEL String string --- ---
    PMDOMID String string --- ---
    PMCOUNTREPID String string --- ---
    domain String string domain [WDM]
    id String string id ---

    ReportProfilesDto

    Name

    Type

    Description

    Enum

    repId String string returns report id ---
    repWindow String string report window [15 mins , 1 hour , 2 hours , 24 hours , 1 week , 1 month]
    format String string format [CSV]
    csvRepository String string csvRepository ---
    userlabel String string returns the userlabel ---
    destType String string destType [FILES]
    reportRes Integer integer --- ---
    destName String string Specifies the path where the file is getting stored ---
    correlated String string Specifies whether the profile is correlated or not [true , false]
    measId Long long returns the measure id which exists in db based on granularity ---
    id Integer integer returns id ---

    Serializable

    Name

    Type

    Description

    Enum

    tcaDto

    Name

    Type

    Description

    Enum

    allowedprofilegroup Integer integer allowedprofilegroup based on Profile Type and Direction ---
    userlabel String string Label given by the user at the time of profile creation ---
    pmtcaid String string Returns the TCA Profile Id ---
    pmtprequireddirection String string pmtprequireddirection [TRMT , RCV]
    pmLayerRate String string Defines layer rate based on selected Profile Type ---
    signalType String string Defines the signal type based on Profile Type and Layer Rate ---
    neFamily String string --- ---
    xosDirection String string xosDirection [trmt , rcv]
    allowedprofilegrp String string allowedprofilegroup based on Profile Type and Direction [OPT , OPR , SDH:SONET]
    proftype String string proftype [Analog , Digital , Both]
    id String string id ---
    pmgranularity String string pmgranularity [15 Min , 24 Hour]
    profiletype Integer integer profiletype ---
    tcaData Object object returns tcaData ---

    View

    Name

    Type

    Description

    Enum

    contentType String string --- ---

    Void

    Name

    Type

    Description

    Enum