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

Create Clear Alarms

Description

This operation creates a ClearAlarms entity.

Request

Request

URL

URL


post
https://{api_host}tcsa.host.com/tcsa/api/tmf/v1/clearAlarms
Copy

Request Body

Request Body

ClearAlarmsCreate of mimetype application/json Required

The ClearAlarms to be created

{
    "alarmPattern": [
        {
            "alarmedObjectType": "Container",
            "state": "ACTIVE"
        },
        {
            "id": "Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"
        }
    ],
    "clearSystemId": "postman-api"
}
array of Alarm
alarmPattern Required

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 Required

Name of the clearing system


string as date-time
alarmClearedTime Optional

Time of the alarm clearing


string
clearUserId Optional

Name of the clearing user


array of AlarmRefOrValue
clearedAlarm Optional

The successfully cleared alarms


string
state Optional

Current state of the operation task

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns ClearAlarms of type application/json
{
	"@baseType": null,
	"@schemaLocation": null,
	"@type": null,
	"alarmClearedTime": "2022-11-02T10:58:03.916199Z",
	"alarmPattern": [
		{
			"alarmedObjectType": "Container",
			"state": "ACTIVE"
		},
		{
			"id": "Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"
		}
	],
	"clearSystemId": "postman-api",
	"clearUserId": "admin",
	"clearedAlarm": [],
	"href": "/tcsa/api/tmf/v1/clearAlarms/qUf9N4QB9XatrL7ssv0U",
	"id": "qUf9N4QB9XatrL7ssv0U",
	"state": "IN_PROGRESS"
}
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

Errors

Errors

Error
400

Bad Request


Error
401

Unauthorized


Error
403

Forbidden


Error
405

Method Not allowed


Error
409

Conflict


Error
500

Internal Server Error

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"ClearAlarmsCreate":{"alarmPattern":[{"alarmedObjectType":"Container","state":"ACTIVE"},{"id":"Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"}],"clearSystemId":"postman-api"},"alarmPattern":[{"alarmedObjectType":"Container","state":"ACTIVE"},{"id":"Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"}],"clearSystemId":"postman-api","clearUserId":"admin"}' https://{api_host}tcsa.host.com/tcsa/api/tmf/v1/clearAlarms
Vendor Extensions

Vendor Extensions

This operation contains the following vendor extensions defined in the spec:
x-codegen-request-body-name: clearAlarms


Feedback

Was this page helpful?