Cisco Cisco Prime Central 1.5 Developer's Guide
Cisco Specific Interfaces
Cisco Prime OSS Integration Guide for MTOSI and 3GPP
122
122
OL-31029-01
2
Ticket does not exist on the
PrimeNetwork.
PrimeNetwork.
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:
DM[<comURI>]=>Message[API_ERROR:<Operation
Name> operation failed. Reason:
<DM_Error_Message>]
where:
<Operation Name>: the operation name, e.g.
Acknowledge
<comURI>: the comURI of the responding DM
<DM_Error_Message>: the error message returned
by DM.
containing the alarmApiException.
The alarmApiException code will be API_ERROR
and message will contain the information:
DM[<comURI>]=>Message[API_ERROR:<Operation
Name> operation failed. Reason:
<DM_Error_Message>]
where:
<Operation Name>: the operation name, e.g.
Acknowledge
<comURI>: the comURI of the responding DM
<DM_Error_Message>: the error message returned
by DM.
9.2.4 AlarmMgmt::Retire
Description:
This API is used to retire(archive) a Prime Network Ticket.
Input:
Sl.No
Parameter
Data Type
Description
1
uniqueId
String
This parameter describes the prime
network ticket ID.
This ID could be an integer or of
format {[NewAlarm(Id=X)]}
network ticket ID.
This ID could be an integer or of
format {[NewAlarm(Id=X)]}
2
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 an Prime Network
Ticket.
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 an Prime Network
Ticket.
3
Username
String
Optional attribute. The user on behalf
of whom the operation is done.
of whom the operation is done.
Output:
Sl.No
Parameter
Data Type
Description
1
uniqueId
String
The same value which is used in the
operation.
operation.
2
Hint
String
The same value which is used in the
operation.
operation.
3
Success
boolean
Value denoting the result of the
operation - “true” in case of success.
operation - “true” in case of success.