Operation
post /sdh-report-controller/data/cpm/archiveOper/{sessionID}
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
Responses
Response Messages |
Schema |
---|---|
200success |
ArchiveOperationDto
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
Tags
[ PM]
Operation
post /sdh-report-controller/consistpm
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
Responses
Response Messages |
Schema |
---|---|
200success |
JqgridResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /sdh-report-controller/correlate
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 | optional | session | HttpSession |
--- |
body2 | required | cpmTcaUserInputWrapper | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
CpmTcaResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /sdh-report-controller/corrOrUncorrReportProfile
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
Responses
Response Messages |
Schema |
---|---|
200success |
JqgridResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /sdh-report-controller/data/cpm/archiveRules
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
Responses
Response Messages |
Schema |
---|---|
200success |
ArchiveRuleDto
|
401Unauthorized | --- |
303Session ended |
Void
|
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /sdh-report-controller/data/cpm/archiveSessions
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
Responses
Response Messages |
Schema |
---|---|
200success |
ArchiveSessionsDto
|
401Unauthorized | --- |
303Session ended |
Void
|
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /sdh-report-controller/maxArchiveSessions
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ArchiveSessionsDto
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /sdh-report-controller/data/cpm/getReportProfileGridView/{id}
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
Responses
Response Messages |
Schema |
---|---|
200success |
Report
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /sdh-report-controller/data/cpm/getReportProfileGridView
UI navigation link :
1.Click Design-->PM Templates
2.Click on My Profiles
3.Select Report Profile from the tree
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Report
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /sdh-report-controller/data/cpm/getTcaProfileGridView/{id}
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
Responses
Response Messages |
Schema |
---|---|
200success |
tcaDto
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /sdh-report-controller/data/cpm/getTcaProfileGridView
UI navigation link :
1.Click Design-->PM Templates
2.Click on My Profiles
3.Select TCA Profile from the tree
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
tcaDto
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /sdh-report-controller/asapDetails
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JqgridResponse«ReportProfilesDto»
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /sdh-report-controller/data/cpm/getAvailReportProfiles/{operationType}/{connId}/{gran}/{client}
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
Responses
Response Messages |
Schema |
---|---|
200success |
ReportProfilesDto
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Tags
[ PM ]
Operation
post /sdh-report-controller/getAvailReportProfiles
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | required | pminput | PMReportUserInput |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ReportProfilesDto
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /sdh-report-controller/getAvailProfiles
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | pminput | PMReportUserInput |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JqgridResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /sdh-report-controller/data/cpm/getAvailTcaProfiles/{xosDir}/{reqDirection}/{granStr}/{monitoredRate}/{pmLayerRate}/{isPsdEth}/{id}
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 | --- |
id | required | id | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
NmlTcaProfile
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
post /sdh-report-controller/getEsmMclagDetails
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
Responses
Response Messages |
Schema |
---|---|
200success |
JqgridResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /sdh-report-controller/getEsmOamTestDetails
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
Responses
Response Messages |
Schema |
---|---|
200success |
JqgridResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /sdh-report-controller/getMaxNodeRowsForPmPoints
UI navigation link :
1.Click Design-->PM Templates
2.Click on My Profiles
3.Select Report Profile from the tree
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
Report
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /sdh-report-controller/data/cpm/monTps/{connId}/{client}
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
Responses
Response Messages |
Schema |
---|---|
200success |
MonitoredTPsDto
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Tags
[ PM]
Operation
get /sdh-report-controller/data/cpm/monTpsSDHCPM/{connId}/{transpType}
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 | connectionName optional for SDH. |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
MonitoredTPsDtoExt
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Tags
[ PM]
Operation
post /sdh-report-controller/monitoredtps
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | pminput | PMReportUserInput |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JqgridResponse«MonitoredTPsDto»
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /sdh-report-controller/getNextChart
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
Responses
Response Messages |
Schema |
---|---|
200success |
JqgridResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /sdh-report-controller/getEsmTpsOfService
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
Responses
Response Messages |
Schema |
---|---|
200success |
JqgridResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /sdh-report-controller/locale
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
JqgridResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /sdh-report-controller/connection/{connId}/showPm
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
connId | required | connId | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
ModelAndView
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
*/*
External Docs
Operation
post /sdh-report-controller/pmdataforconns
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
Responses
Response Messages |
Schema |
---|---|
200success |
JasperDto
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /sdh-report-controller/pmdata
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
Responses
Response Messages |
Schema |
---|---|
200success |
JasperDto
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /sdh-report-controller/pmdata/tpids
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
Responses
Response Messages |
Schema |
---|---|
200success |
JasperDto
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /sdh-report-controller/showpmtps
Request body
Name |
IsRequired |
Description |
Data Type |
Enum |
---|---|---|---|---|
body | optional | pminput | PMReportUserInput |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
DeferredResult«JqgridResponse«PMTpDto»»
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
get /sdh-report-controller/data/cpm/showpmtps/{neGroupId}/{emlNeId}/{tpPortLabel}/{reqGranularity}/{cltTz}
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
Responses
Response Messages |
Schema |
---|---|
200success |
PMTpDto
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Tags
[ PM]
Operation
get /sdh-report-controller/data/cpm/nepmtps/{neName}/{startTime}/{endTime}/{gran}/{cltTz}
Path parameters
Name |
IsRequired |
Description |
Enum |
---|---|---|---|
neName | required | neName | --- |
cltTz | required | cltTz | --- |
startTime | required | startTime | --- |
endTime | required | endTime | --- |
gran | required | gran | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
PMTpDto
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
External Docs
Operation
get /sdh-report-controller/data/cpm/showpmtps/{nodeId}/{neId}/{cltTz}
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] |
id | required | id | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
PMTpDto
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Tags
[ PM]
Operation
get /sdh-report-controller/data/cpm/showpmtps/{nodeId}/{neId}/{cltTz}/{id}
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] |
id | required | id | --- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
PMTpDto
|
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Produces
application/json
Tags
[ PM]
Operation
post /sdh-report-controller/stopOnGoingReq
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
Responses
Response Messages |
Schema |
---|---|
200success |
JqgridResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /sdh-report-controller/uncorrelate
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 | optional | session | HttpSession |
--- |
body2 | required | cpmTcaUserInputWrapper | String |
--- |
Return type
Responses
Response Messages |
Schema |
---|---|
200success |
CpmTcaResponse
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
External Docs
Operation
post /sdh-report-controller/data/cpm/archiveRules/{ruleId}
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
Responses
Response Messages |
Schema |
---|---|
200success |
ArchiveSessionsDto
|
201Created | --- |
401Unauthorized | --- |
403Forbidden | --- |
404Not Found | --- |
Consumes
application/json
Produces
application/json
Tags
[ PM]
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 |
--- | --- |
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 |
--- | --- |
ModelAndView
Name |
Type |
Description |
Enum |
---|---|---|---|
view | View View |
--- | --- |
model | Object object |
--- | --- |
status | String string |
--- | [100 CONTINUE, 101 SWITCHING_PROTOCOLS, 102 PROCESSING, 103 CHECKPOINT, 200 OK, 201 CREATED, 202 ACCEPTED, 203 NON_AUTHORITATIVE_INFORMATION, 204 NO_CONTENT, 205 RESET_CONTENT, 206 PARTIAL_CONTENT, 207 MULTI_STATUS, 208 ALREADY_REPORTED, 226 IM_USED, 300 MULTIPLE_CHOICES, 301 MOVED_PERMANENTLY, 302 FOUND, 302 MOVED_TEMPORARILY, 303 SEE_OTHER, 304 NOT_MODIFIED, 305 USE_PROXY, 307 TEMPORARY_REDIRECT, 308 PERMANENT_REDIRECT, 400 BAD_REQUEST, 401 UNAUTHORIZED, 402 PAYMENT_REQUIRED, 403 FORBIDDEN, 404 NOT_FOUND, 405 METHOD_NOT_ALLOWED, 406 NOT_ACCEPTABLE, 407 PROXY_AUTHENTICATION_REQUIRED, 408 REQUEST_TIMEOUT, 409 CONFLICT, 410 GONE, 411 LENGTH_REQUIRED, 412 PRECONDITION_FAILED, 413 PAYLOAD_TOO_LARGE, 413 REQUEST_ENTITY_TOO_LARGE, 414 URI_TOO_LONG, 414 REQUEST_URI_TOO_LONG, 415 UNSUPPORTED_MEDIA_TYPE, 416 REQUESTED_RANGE_NOT_SATISFIABLE, 417 EXPECTATION_FAILED, 418 I_AM_A_TEAPOT, 419 INSUFFICIENT_SPACE_ON_RESOURCE, 420 METHOD_FAILURE, 421 DESTINATION_LOCKED, 422 UNPROCESSABLE_ENTITY, 423 LOCKED, 424 FAILED_DEPENDENCY, 426 UPGRADE_REQUIRED, 428 PRECONDITION_REQUIRED, 429 TOO_MANY_REQUESTS, 431 REQUEST_HEADER_FIELDS_TOO_LARGE, 451 UNAVAILABLE_FOR_LEGAL_REASONS, 500 INTERNAL_SERVER_ERROR, 501 NOT_IMPLEMENTED, 502 BAD_GATEWAY, 503 SERVICE_UNAVAILABLE, 504 GATEWAY_TIMEOUT, 505 HTTP_VERSION_NOT_SUPPORTED, 506 VARIANT_ALSO_NEGOTIATES, 507 INSUFFICIENT_STORAGE, 508 LOOP_DETECTED, 509 BANDWIDTH_LIMIT_EXCEEDED, 510 NOT_EXTENDED, 511 NETWORK_AUTHENTICATION_REQUIRED] |
viewName | String string |
--- | --- |
reference | Boolean boolean |
--- | --- |
modelMap | ModelMap ModelMap |
--- | --- |
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 | --- |
layerRate | String string |
return 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 |
--- | --- |
PMReportUserInput
Name |
Type |
Description |
Enum |
---|---|---|---|
selectedEntities | String string |
returns Connection Id. For Example: 1,2 : Shows multiple connection ID value and are separated by comma. Applicable at Connection Level. hookmapper1^hookmapper2 : Shows Hookmapper and seperated by ^. Applicable at TP Level. Note: Its a mandatory field. if not usable then its value = 0 and return as part of selectedEntities. |
--- |
fromTime | String string |
returns Start Time for PM Report. For Example: 2018-12-16-15:52 : Shows Date and Time in General form: YYYY-MM-DD-HH:MM ' ' : Shows Empty Space. Note: Its a mandatory field. |
--- |
endTime | String string |
returns End Time for PM Report generated. For Example: 2018-12-16-15:52 : Shows Date and Time in General form: YYYY-MM-DD-HH:MM ' ' : Shows Empty Space. |
--- |
granularity | String string |
returns granularity. For Example: 24Hr : Shows for 1 day PM Report 15min : Shows for 15 minutes PM Report. Note: Its a mandatory field and example may differ based upon the operations. |
--- |
clientTz | String string |
returns 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. Note: Its a mandatory field. |
--- |
expFormat | String string |
returns PM Report export format. For Example: ' ': Shows Tabular PM Report Export Format. LINE: Shows Line chart Export Format. BAR: Shows Bar chart Export Format. CSV: Shows CSV Format PM Report. HTML: Shows HTML Format PM Report. PDF: Shows PDF Format PM Report. Note: Its a mandatory field. |
--- |
emlMapper | Integer integer |
returns eml sna id. For Example : 101 |
--- |
fdnMapper | String string |
Fully distinguished name for Termination Point associated to Connectivities. For Example : 101/25/11DPM12-1-4-C2|||| |
--- |
portLabel | String string |
returns Port Label for the selected Termination Point associated to Connectivities. For Example:OTU-1-11-1 |
--- |
tptype | Integer integer |
returns Type for Termination Point based upon Granularity. For Example: 0 for 1 Day. 1 for 15 Minutes. |
--- |
xosDir | Integer integer |
returns xosDirection for the Selected Termination Points For Example: 1 for Transmit End Termination Point. 2 for Receive End Termination Point. |
--- |
reqDirection | Integer integer |
returns Request direction for Termination Points associated to Connectivities. For Example: TRMT for Transmit End Termination Point. RCV for Receive End Termination Point. |
--- |
monitoredRate | Integer integer |
returns Monitored rate based upon respective Termination Points. For Example:OS, DSR |
--- |
pmLayerRate | Integer integer |
returns Pm layer rate based upon respective Termination Points. For Example:19, 20 |
--- |
operationType | Integer integer |
returns as Operation Type. For Example: 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. |
--- |
neName | String string |
returns NE name to associated Connectivities. For Example:11DPM12-1-4-L1-1 |
--- |
measId | String string |
This corresponds to either 15min or 24hrs measure of associated Connectivities. For Example: 1 : Shows measId of connection. |
--- |
tpId | Long long |
returns Termination Points id for the selected Termination Point. For Example:1 |
--- |
tpIds | String string |
returns list of Termination Point Ids. For Example:1,2,3 |
--- |
profId | Long long |
returns selected TCA profile Id. For Example:1 1 : Shows TCA profile Id. |
--- |
repId | String string |
returns report id Note: Its a optional field. |
--- |
connId | String string |
returns as connection type to associated Connectivities. For Example: -1 for Physical connection 0 for both Infra connection and Service Connection. Note: Its a mandatory field. |
--- |
databasetype | String string |
returns databasetype Note: Its a optional field. |
--- |
userLabel | String string |
returns Transp User Label. For Example:userLabel1 Note: Its a optional field. |
--- |
transpType | String string |
returns Transp Type Enum. Note: Its a optional field. |
--- |
pmTpType | String string |
--- | --- |
cpmtpIds | String string |
returns List of CPMTP ID. This information is used to select the specific Monitored points identification to require the History PM for the specipic termination point. |
--- |
user | String string |
--- | --- |
requestId | String string |
--- | --- |
sessionId | String string |
--- | --- |
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 | --- |
Void
Name |
Type |
Description |
Enum |
---|