Cisco Cisco Prime Central 1.5.2 開発者ガイド

ページ / 223
Cisco Specific Interfaces
 
9.2.3  AlarmMgmt::Clear 
Description: 
This API is used to force clear a Prime Network Ticket. 
Input: 
Sl.No 
Parameter  
Data Type 
Description 
uniqueId 
String 
This  parameter  describes the Prime 
Network Ticket ID. 
This ID could be an integer or of  
format  {[NewAlarm(Id=X)]} 
Hint 
String 
Optional value that can be used as 
extra meta data in processing the 
requests. For example, OSS application 
or FM can use this as a 
timestamp/version/state value that 
can be used to correlate actions to 
avoid issues with concurrent actions 
performed on a Prime Network Ticket. 
Note 
String 
Optional note to include while 
performing the operation. 
Username 
String 
Optional attribute. The user on behalf 
of whom the operation is done. 
 
Output: 
Sl.No 
Parameter  
Data Type 
Description 
uniqueId 
String 
The same value which is used in the 
operation. 
Hint 
String 
The same value which is used in the 
operation. 
Success 
boolean 
Value denoting the result of the 
operation - “true” in case of success. 
Error: 
Sl.No 
Condition 
Error 
Invalid ID provided for the 
operation in StandAlone 
Integration layer deployment. 
When user provides improper ticketId (not in 
expected format), the operation will return soap 
fault with the detail containing the 
alarmApiException. The alarmApiException code 
will be API_ERROR and message will contain the 
information: 
Please enter the PN Ticket Number or OID(format:  
[NewAlarm(Id=<Ticket Number>)] 
 
Cisco Prime OSS  Integration  Guide for  MTOSI and 3GPP 
 
 
125