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

Create Un Ack Alarms

Description

This operation creates an UnAckAlarms entity.

Request

Request

URL

URL


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

Request Body

Request Body

UnAckAlarmsCreate of mimetype application/json Required

The UnAckAlarms to be created

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

Name of the unacknowledging system


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 as date-time
ackTime Optional

Time of the unacknowledgement


string
ackUserId Optional

Name of the unacknowledging user


string
state Optional

Current state of the operation task


array of AlarmRefOrValue
unAckedAlarm Optional

The successfully unacknowledged alarms

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

201 Created

Returns UnAckAlarms of type application/json
{
	"@baseType": null,
	"@schemaLocation": null,
	"@type": null,
	"ackSystemId": "postman-api",
	"ackTime": "2022-11-02T11:05:58.072525Z",
	"ackUserId": "admin",
	"alarmPattern": [
		{
			"alarmedObjectType": "Container",
			"state": "ACTIVE"
		},
		{
			"id": "Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"
		}
	],
	"href": "/tcsa/api/tmf/v1/unAckAlarms/20gEOIQB9XatrL7s7kI8",
	"id": "20gEOIQB9XatrL7s7kI8",
	"state": "IN_PROGRESS",
	"unAckedAlarm": []
}
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
ackSystemId Optional

Name of the unacknowledging system


string as date-time
ackTime Optional

Time of the unacknowledgement


string
ackUserId Optional

Name of the unacknowledging user


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
href Optional

A reference to the task


string
id Optional

The identifier of the task


string
state Optional

Current state of the operation task


array of AlarmRefOrValue
unAckedAlarm Optional

The successfully unacknowledged alarms

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 '{"UnAckAlarmsCreate":{"ackSystemId":"postman-api","alarmPattern":[{"alarmedObjectType":"Container","state":"ACTIVE"},{"id":"Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"}]},"ackSystemId":"postman-api","ackUserId":"admin","alarmPattern":[{"alarmedObjectType":"Container","state":"ACTIVE"},{"id":"Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"}],"state":"IN_PROGRESS"}' https://{api_host}tcsa.host.com/tcsa/api/tmf/v1/unAckAlarms
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?