Cisco Prime Infrastructure API
Prime Infrastructure API Documentation

PUT alarms/annotate

Annotates one or more alarms

Since Product Version: 3.3

Resource Information

Rate Limiting?

No

Sorting?

No

Paging?

No

Filtering?

No

Group Filtering?

No

Aggregation?

No

Response Formats

xml

json

User Group

NBI Write

HTTP Methods

PUT

API version v1 is deprecated

This API version has been deprecated. It will be removed in a future release of the product. Please develop new clients using the latest API version. Please modify your existing clients to use a later API version.

Resource URL

/webacs/api/v1/op/alarms/annotate

Request Parameters

Attribute Source Description

note String

query

Optional

Annotation note

Request Payload Parameters

Attribute Description

ids Long[]

Required

List of alarms identificators

Sample Payloads

Sample payloads are for information only. They are automatically generated and the values included may not be representative of actual valid data values.

Sample XML Request Payload

https://localhost/webacs/api/v1/op/alarms/annotate

<?xml version="1.0" ?>
<alarmIdListDTO>
  <ids>
    <id>15</id>
  </ids>
</alarmIdListDTO>

Sample JSON Request Payload

https://localhost/webacs/api/v1/op/alarms/annotate.json

{
  "alarmIdListDTO" : {
    "ids" : {
      "id" : 15
    }
  }
}