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

Create Comment Alarms

Description

This operation creates a CommentAlarms entity.

Request

Request

URL

URL


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

Request Body

Request Body

CommentAlarmsCreate of mimetype application/json Required

The CommentAlarms to be created

{
    "alarmPattern": [
        {
            "alarmedObjectType": "Container",
            "state": "ACTIVE"
        },
        {
            "id": "Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"
        }
    ],
    "comment": {
        "comment": "Testing Comment Alarms OpenAPI"
    }
}
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.


comment Required

Indicates the comments entered on the alarm.


array of AlarmRefOrValue
commentedAlarm Optional

The successfully commented 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 CommentAlarms of type application/json
{
	"@baseType": null,
	"@schemaLocation": null,
	"@type": null,
	"alarmPattern": [
		{
			"alarmedObjectType": "Container",
			"state": "ACTIVE"
		},
		{
			"id": "Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"
		}
	],
	"comment": {
		"@baseType": "alarm",
		"@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
		"@type": "notification",
		"comment": "Testing Comment Alarms OpenAPI",
		"systemId": null,
		"time": "2022-11-02T11:07:44Z",
		"userId": "admin"
	},
	"commentedAlarm": [],
	"href": "/tcsa/api/tmf/v1/commentAlarms/hEgGOIQB9XatrL7sjVDb",
	"id": "hEgGOIQB9XatrL7sjVDb",
	"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


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.


comment Optional

Indicates the comments entered on the alarm.


array of AlarmRefOrValue
commentedAlarm Optional

The successfully commented 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 '{"CommentAlarmsCreate":{"alarmPattern":[{"alarmedObjectType":"Container","state":"ACTIVE"},{"id":"Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"}],"comment":{"comment":"Testing Comment Alarms OpenAPI"}},"alarmPattern":[{"alarmedObjectType":"Container","state":"ACTIVE"},{"id":"Name:NOTIFICATION-VPN_VPN-100_:9900_Impacted$Source:INCHARGE-SA-PRES$"}],"comment":{"comment":"Testing Comment Alarms OpenAPI"}}' https://{api_host}tcsa.host.com/tcsa/api/tmf/v1/commentAlarms
Vendor Extensions

Vendor Extensions

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


Feedback

Was this page helpful?