[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance

ClearAlarms

Task resource for clear alarms operation


Properties

string
@baseType Optional

When sub-classing, this defines the super-class


string as uri
@schemaLocation Optional

A URI to a JSON-Schema file that defines additional attributes and relationships


string
@type Optional

When sub-classing, this defines the sub-class entity name


string as date-time
alarmClearedTime Optional

Time of the alarm clearing


array of Alarm
alarmPattern Optional

Alarm patterns to match target alarms. An alarm will match if an attribute in any of the patterns is equal to the corresponding attribute of the alarm. The attributes which are supported with matching are - id, alarmType, alarmedObjectType, perceivedSeverity, plannedOutageIndicator and state.


string
clearSystemId Optional

Name of the clearing system


string
clearUserId Optional

Name of the clearing user


array of AlarmRefOrValue
clearedAlarm Optional

The successfully cleared alarms


string
href Optional

A reference to the task


string
id Optional

The identifier of the task


string
state Optional

Current state of the operation task

JSON Example

{
    "alarmClearedTime": "2022-10-25T12:18:06.690858Z",
    "clearSystemId": "postman-api",
    "clearUserId": "admin",
    "href": "/tcsa/api/tmf/v1/clearAlarms/AS0UD4QBpi1WVs4LGnPr",
    "id": "AS0UD4QBpi1WVs4LGnPr",
    "state": "COMPLETED"
}
[{"label":"Latest (2.0.1)","version":"latest"}]
telco-cloud-service-assurance
Returned By

List Clear Alarms
Create Clear Alarms
Retrieve Clear Alarms

Feedback

Was this page helpful?