Patch Alarm

Patch Alarm

This operation updates partially, an Alarm entity.

Request
URI
PATCH
https://{api_host}/tcsa/api/tmf/v1/alarms/{id}
COPY
Path Parameters
string
id
Required

Identifier of the Alarm

id example 
Name:NOTIFICATION-gNodeB_gNodeB-service-mavenir_OpenAPIExample$Source:INCHARGE-SA-PRES$
Request Body

The Alarm to be updated

AlarmUpdate of type(s) application/json
Required 
{
    "ackState": "string",
    "ackSystemId": "string",
    "ackUserId": "string",
    "alarmChangedTime": "string",
    "alarmClearedTime": "string",
    "alarmDetails": "Updating alarm details",
    "alarmEscalation": false,
    "alarmRaisedTime": "string",
    "alarmReportingTime": "string",
    "alarmType": "string",
    "alarmedObjectType": "string",
    "clearSystemId": "string",
    "clearUserId": "string",
    "externalAlarmId": "string",
    "isRootCause": false,
    "perceivedSeverity": "NORMAL",
    "plannedOutageIndicator": "PLANNED_MAINTENANCE",
    "probableCause": "Updating probableCause",
    "proposedRepairedActions": "string",
    "reportingSystemId": "string",
    "serviceAffecting": false,
    "sourceSystemId": "string",
    "specificProblem": "string",
    "state": "string",
    "affectedService": [
        {
            "id": "string",
            "href": "string",
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string"
        }
    ],
    "alarmedObject": {
        "id": "KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b$KubernetesPod$INCHARGE-SA-PRES",
        "href": "/tcsa/api/topology/v1/instances/KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b%24KubernetesPod%24INCHARGE-SA-PRES",
        "@baseType": "alarm",
        "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
        "@type": "notification"
    },
    "comment": [
        {
            "comment": "Testing Comments for openAPI spec",
            "systemId": "postman-api",
            "time": "string",
            "userId": "string",
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string"
        }
    ],
    "correlatedAlarm": [
        {
            "id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
            "href": "/tcsa/api/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed%24Source%3AINCHARGE-SA-PRES%24",
            "name": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
            "@baseType": "alarm",
            "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
            "@type": "notification",
            "@referredType": "string"
        }
    ],
    "crossedThresholdInformation": {
        "direction": "string",
        "granularity": "string",
        "indicatorName": "string",
        "indicatorUnit": "string",
        "observedValue": "string",
        "thresholdCrossingDescription": "string",
        "threshold": {
            "id": "string",
            "href": "string",
            "name": "string",
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string",
            "@referredType": "string"
        },
        "@baseType": "string",
        "@schemaLocation": "string",
        "@type": "string"
    },
    "parentAlarm": [
        {
            "id": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
            "href": "/tcsa/api/alarms/Name%3ANOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed%24Source%3AINCHARGE-SA-PRES%24",
            "name": "Name:NOTIFICATION-KubernetesPod_KubernetesPod-072c77d1-7765-46e9-9846-96e81ea43f0b_Failed$Source:INCHARGE-SA-PRES$",
            "@baseType": "alarm",
            "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
            "@type": "notification",
            "@referredType": "string"
        }
    ],
    "place": [
        {
            "id": "string",
            "href": "string",
            "name": "string",
            "role": "string",
            "@baseType": "string",
            "@schemaLocation": "string",
            "@type": "string",
            "@referredType": "string"
        }
    ]
}
string
ackState
Optional

Provides the Acknowledgement State of the alarm

string
ackSystemId
Optional

Provides the name of the system that last changed the ackState of an alarm, i.e. acknowledged or unacknowledged the alarm.

string
ackUserId
Optional

Provides the id of the user who has last changed the ack state of the alarm, i.e. acknowledged or unacknowledged the alarm.

string As date-time As date-time
alarmChangedTime
Optional

Indicates the last date and time when the alarm is changed on the alarm-owning system. Any change to the alarm whether coming from the alarmed resource, or triggered by a change from the client is changing this time.

string As date-time As date-time
alarmClearedTime
Optional

Indicates the time (as a date + time) at which the alarm is cleared at the source.

string
alarmDetails
Optional

Contains further information on the alarm.

boolean
alarmEscalation
Optional

Indicates if this alarm has been escalated or not.

string As date-time As date-time
alarmRaisedTime
Optional

Indicates the time (as a date + time) at which the alarm occurred at its source.

string As date-time As date-time
alarmReportingTime
Optional

Indicates the time (as a date + time) at which the alarm was reported by the owning OSS. It might be different from the alarmRaisedTime. For instance, if the alarm list is maintained by an EMS, the alarmRaisedtime would be the time the alarm was detected by the NE, while the alarmReportingTime would be the time this alarm was stored in the alarm list of the EMS.

string
alarmType
Optional

Categorize the alarm.

string
alarmedObjectType
Optional

The type (class) of the managed object associated with the event.

string
clearSystemId
Optional

Provides the id of the system where the user who invoked the alarmCleared operation is located.

string
clearUserId
Optional

Provides the id of the user who invoked the alarmCleared operation

string
externalAlarmId
Optional

An identifier of the alarm in the source system.

boolean
isRootCause
Optional

Indicates whether the alarm is a root cause alarm..

string
perceivedSeverity
Optional

Lists the possible severities that can be allocated to an Alarm.

Possible values are : CRITICAL, MAJOR, MINOR, NORMAL, UNKNOWN,
string
plannedOutageIndicator
Optional

Indicates that the Managed Object (related to this alarm) is in planned outage (in planned maintenance, or out-of-service).

Possible values are : PLANNED_MAINTENANCE, OUT_OF_SERVICE,
string
probableCause
Optional

Provides the probable cause of the alarm.

string
proposedRepairedActions
Optional

Indicates proposed repair actions, if known to the system emitting the alarm.

string
reportingSystemId
Optional

Reporting system identity.

boolean
serviceAffecting
Optional

Indicates whether the alarm affects service or not.

string
sourceSystemId
Optional

Source system identity.

string
specificProblem
Optional

Provides more specific information about the alarm.

string
state
Optional

Defines the alarm state during its life cycle

array of object
affectedService
Optional

Identifies the service affected by the alarm.

object
alarmedObject
Optional

Identifies the managed object instance associated with the alarm.

array of object
comment
Optional

Indicates the comments entered on the alarm.

array of object
correlatedAlarm
Optional

Indicates other alarms related to this alarm.

object
crossedThresholdInformation
Optional

Identifies the details of the threshold that has been crossed.

array of object
parentAlarm
Optional

Indicates the parent alarms of the alarm.

array of object
place
Optional

Related Entity reference. A related place defines a place described by reference or by value linked to a specific entity. The polymorphic attributes @type, @schemaLocation & @referredType are related to the place entity and not the RelatedPlaceRefOrValue class itself

Authentication
This operation uses the following authentication methods.
Responses
200

Updated

Returns AlarmUpdateResponse of type(s) application/json 
{
    "id": "Name:NOTIFICATION-gNodeB_gNodeB-service-mavenir_OpenAPIExample$Source:INCHARGE-SA-PRES$",
    "href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-gNodeB_gNodeB-service-mavenir_OpenAPIExample%24Source%3AINCHARGE-SA-PRES%24"
}
string
id
Optional

Identifier of the alarm, determined by the alarm owning system

string
href
Optional

A reference to the alarm.


400

Bad Request

Returns Error of type(s) application/json 
"Error Object"
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


401

Unauthorized

Returns Error of type(s) application/json 
"Error Object"
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


403

Forbidden

Returns Error of type(s) application/json 
"Error Object"
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


404

Not Found

Returns Error of type(s) application/json 
"Error Object"
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


405

Method Not allowed

Returns Error of type(s) application/json 
"Error Object"
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


409

Conflict

Returns Error of type(s) application/json 
"Error Object"
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


500

Internal Server Error

Returns Error of type(s) application/json 
"Error Object"
string
code
Required

Application relevant detail, defined in the API or a common list.

string
reason
Required

Explanation of the reason for the error which can be shown to a client user.

string
message
Optional

More details and corrective actions related to the error which can be shown to a client user.

string
status
Optional

HTTP Error code extension

string As uri As uri
referenceError
Optional

URI of documentation describing the error.

string
@baseType
Optional

When sub-classing, this defines the super-class.

string As uri 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.


Code Samples
COPY 
                    curl -X PATCH -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}'
On This Page
Tmf Alarms Operations
GET
List Alarm
POST
Create Alarm
GET
Retrieve Alarm
DELETE
Delete Alarm
PATCH
Patch Alarm
GET
List Ack Alarms
POST
Create Ack Alarms
GET
Retrieve Ack Alarms
GET
List Un Ack Alarms
POST
Create Un Ack Alarms
GET
Retrieve Un Ack Alarms
GET
List Clear Alarms
POST
Create Clear Alarms
GET
Retrieve Clear Alarms
GET
List Comment Alarms
POST
Create Comment Alarms
GET
Retrieve Comment Alarms