Retrieve Comment Alarms

Retrieve Comment Alarms

This operation retrieves a CommentAlarms entity. Attribute selection is enabled for all first level attributes.

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

Identifier of the CommentAlarms

id example
4gDJEoQBpi1WVs4LG3oY
Query Parameters
string
fields
Optional

Comma-separated properties to provide in response

fields example
id

Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns CommentAlarms of type(s) application/json
{
    "id": "4gDJEoQBpi1WVs4LG3oY",
    "href": "/tcsa/api/tmf/v1/commentAlarms/4gDJEoQBpi1WVs4LG3oY",
    "state": "COMPLETED",
    "alarmPattern": [
        {
            "id": "Name:NOTIFICATION-Card_CARD-10.31.161.51[limal051]/39896_Down$Source:INCHARGE-SA-PRES$"
        },
        {
            "id": "Name:NOTIFICATION-Blade_BLD-BEM-10.31.161.51[limal051]/1/sys/chassis-1/blade-7_Down$Source:INCHARGE-SA-PRES$"
        },
        {
            "id": "Name:NOTIFICATION-CPU__Performance__HostResources_I-CPU__Performance__HostResources-PSR-10.107.118.170/14_HighUtilization$Source:INCHARGE-SA-PRES$"
        }
    ],
    "comment": {
        "comment": "Testing Comments 2 for openAPI spec",
        "systemId": null,
        "time": "2022-10-25T12:25:58Z",
        "userId": "admin",
        "@baseType": "alarm",
        "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
        "@type": "notification"
    },
    "commentedAlarm": [
        {
            "correlatedAlarm": [],
            "ackSystemId": null,
            "ackUserId": null,
            "affectedService": null,
            "alarmEscalation": null,
            "clearSystemId": null,
            "clearUserId": null,
            "crossedThresholdInformation": {},
            "externalAlarmId": null,
            "probableCause": null,
            "reportingSystemId": null,
            "serviceAffecting": null,
            "specificProblem": null,
            "proposedRepairedActions": null,
            "place": [],
            "instanceName": null,
            "source": null,
            "rootCause": true,
            "id": "Name:NOTIFICATION-Card_CARD-10.31.161.51[limal051]/39896_Down$Source:INCHARGE-SA-PRES$",
            "href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-Card_CARD-10.31.161.51%5Blimal051%5D%2F39896_Down%24Source%3AINCHARGE-SA-PRES%24",
            "ackState": "UNACKNOWLEDGED",
            "alarmChangedTime": "2022-10-25T12:07:04Z",
            "alarmClearedTime": null,
            "alarmDetails": "Indicates that a failed card is the root cause.",
            "alarmRaisedTime": "2022-10-25T12:07:25.494Z",
            "alarmReportingTime": "2022-10-25T12:07:25.494Z",
            "alarmType": "Down",
            "alarmedObjectType": "Card",
            "isRootCause": true,
            "perceivedSeverity": "CRITICAL",
            "plannedOutageIndicator": "OUT_OF_SERVICE",
            "sourceSystemId": "INCHARGE-SA-PRES",
            "state": "ACTIVE",
            "alarmedObject": {
                "id": "BEM-10.31.161.51[limal051]/1$BladeEnclosureManager$INCHARGE-SA-PRES",
                "href": "/tcsa/api/topology/v1/instances/BEM-10.31.161.51%5Blimal051%5D%2F1%24BladeEnclosureManager%24INCHARGE-SA-PRES",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification"
            },
            "comment": [
                {
                    "comment": "Testing Comments 2 for openAPI spec",
                    "systemId": null,
                    "time": "2022-10-25T12:25:58Z",
                    "userId": "admin",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T12:07:04Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Unacknowledged the notification",
                    "systemId": null,
                    "time": "2022-10-25T12:03:36Z",
                    "userId": "admin",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "",
                    "systemId": null,
                    "time": "2022-10-25T11:55:14Z",
                    "userId": "admin",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Testing Comments 1 for openAPI spec",
                    "systemId": null,
                    "time": "2022-10-25T11:55:14Z",
                    "userId": "admin",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Acknowledged the notification",
                    "systemId": null,
                    "time": "2022-10-25T11:50:13Z",
                    "userId": "admin",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T11:47:14Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                }
            ],
            "parentAlarm": [],
            "@baseType": "alarm",
            "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
            "@type": "notification"
        },
        {
            "correlatedAlarm": [],
            "ackSystemId": null,
            "ackUserId": null,
            "affectedService": null,
            "alarmEscalation": null,
            "clearSystemId": null,
            "clearUserId": null,
            "crossedThresholdInformation": {},
            "externalAlarmId": null,
            "probableCause": null,
            "reportingSystemId": null,
            "serviceAffecting": null,
            "specificProblem": null,
            "proposedRepairedActions": null,
            "place": [],
            "instanceName": null,
            "source": null,
            "rootCause": true,
            "id": "Name:NOTIFICATION-Blade_BLD-BEM-10.31.161.51[limal051]/1/sys/chassis-1/blade-7_Down$Source:INCHARGE-SA-PRES$",
            "href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-Blade_BLD-BEM-10.31.161.51%5Blimal051%5D%2F1%2Fsys%2Fchassis-1%2Fblade-7_Down%24Source%3AINCHARGE-SA-PRES%24",
            "ackState": "UNACKNOWLEDGED",
            "alarmChangedTime": "2022-10-25T12:07:04Z",
            "alarmClearedTime": null,
            "alarmDetails": "Indicates that the root cause is a failed system.",
            "alarmRaisedTime": "2022-10-25T12:07:25.494Z",
            "alarmReportingTime": "2022-10-25T12:07:25.495Z",
            "alarmType": "Down",
            "alarmedObjectType": "Blade",
            "isRootCause": true,
            "perceivedSeverity": "CRITICAL",
            "plannedOutageIndicator": "OUT_OF_SERVICE",
            "sourceSystemId": "INCHARGE-AM",
            "state": "INACTIVE",
            "alarmedObject": {
                "id": "BLD-BEM-10.31.161.51[limal051]/1/sys/chassis-1/blade-7$Blade$INCHARGE-SA-PRES",
                "href": "/tcsa/api/topology/v1/instances/BLD-BEM-10.31.161.51%5Blimal051%5D%2F1%2Fsys%2Fchassis-1%2Fblade-7%24Blade%24INCHARGE-SA-PRES",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification"
            },
            "comment": [
                {
                    "comment": "Testing Comments 2 for openAPI spec",
                    "systemId": null,
                    "time": "2022-10-25T12:25:58Z",
                    "userId": "admin",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T12:07:04Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Unacknowledged the notification",
                    "systemId": null,
                    "time": "2022-10-25T12:03:39Z",
                    "userId": "admin",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Acknowledged the notification",
                    "systemId": null,
                    "time": "2022-10-25T11:50:15Z",
                    "userId": "admin",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T11:47:14Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                }
            ],
            "parentAlarm": [],
            "@baseType": "alarm",
            "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
            "@type": "notification"
        },
        {
            "correlatedAlarm": [],
            "ackSystemId": null,
            "ackUserId": null,
            "affectedService": null,
            "alarmEscalation": null,
            "clearSystemId": null,
            "clearUserId": null,
            "crossedThresholdInformation": {},
            "externalAlarmId": null,
            "probableCause": null,
            "reportingSystemId": null,
            "serviceAffecting": null,
            "specificProblem": null,
            "proposedRepairedActions": null,
            "place": [],
            "instanceName": null,
            "source": null,
            "rootCause": true,
            "id": "Name:NOTIFICATION-CPU__Performance__HostResources_I-CPU__Performance__HostResources-PSR-10.107.118.170/14_HighUtilization$Source:INCHARGE-SA-PRES$",
            "href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-CPU__Performance__HostResources_I-CPU__Performance__HostResources-PSR-10.107.118.170%2F14_HighUtilization%24Source%3AINCHARGE-SA-PRES%24",
            "ackState": "UNACKNOWLEDGED",
            "alarmChangedTime": "2022-10-25T12:23:14Z",
            "alarmClearedTime": null,
            "alarmDetails": "Indicates that the utilization of the system's processor exceeds UtilizationThreshold.",
            "alarmRaisedTime": "2022-10-25T12:07:25.494Z",
            "alarmReportingTime": "2022-10-25T12:23:35.997Z",
            "alarmType": "HighUtilization",
            "alarmedObjectType": "CPU_Performance_HostResources",
            "isRootCause": true,
            "perceivedSeverity": "MAJOR",
            "plannedOutageIndicator": "OUT_OF_SERVICE",
            "sourceSystemId": "INCHARGE-AM",
            "state": "INACTIVE",
            "alarmedObject": {
                "id": "10.107.118.170$Host$INCHARGE-SA-PRES",
                "href": "/tcsa/api/topology/v1/instances/10.107.118.170%24Host%24INCHARGE-SA-PRES",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification"
            },
            "comment": [
                {
                    "comment": "Testing Comments 2 for openAPI spec",
                    "systemId": null,
                    "time": "2022-10-25T12:25:58Z",
                    "userId": "admin",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T12:23:14Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Audit trail entries up to and including serial #849 were archived.",
                    "systemId": null,
                    "time": "2022-10-25T12:19:44Z",
                    "userId": "SYSTEM",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T12:19:44Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Unacknowledged the notification",
                    "systemId": null,
                    "time": "2022-10-25T12:03:41Z",
                    "userId": "admin",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T12:03:14Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "New event occurrence",
                    "systemId": null,
                    "time": "2022-10-25T11:59:44Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T11:59:44Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T11:51:14Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Acknowledged the notification",
                    "systemId": null,
                    "time": "2022-10-25T11:50:18Z",
                    "userId": "admin",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T11:47:44Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T11:27:14Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T11:23:44Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T11:19:14Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T11:11:34Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T11:03:04Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T10:59:34Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T10:51:04Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T10:47:34Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T10:43:04Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T10:39:34Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T10:35:04Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T10:31:34Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T10:11:04Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T10:07:34Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T09:59:04Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T09:51:34Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T09:43:04Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T09:39:34Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T09:35:04Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T09:31:34Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T09:19:04Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T09:15:33Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T08:43:03Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T08:39:33Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T08:35:03Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T08:31:33Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T08:06:53Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T08:03:23Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T07:06:53Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T07:03:22Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T06:58:52Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T06:55:22Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T06:50:52Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T06:47:22Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T06:38:52Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T06:31:22Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T06:18:52Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T06:15:22Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T06:10:52Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T06:07:22Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Server: INCHARGE-SA",
                    "systemId": null,
                    "time": "2022-10-25T05:50:52Z",
                    "userId": "DXA",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                },
                {
                    "comment": "Audit trail entries up to and including serial #799 were archived.",
                    "systemId": null,
                    "time": "2022-10-25T05:43:22Z",
                    "userId": "SYSTEM",
                    "@baseType": "alarm",
                    "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                    "@type": "notification"
                }
            ],
            "parentAlarm": [],
            "@baseType": "alarm",
            "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
            "@type": "notification"
        }
    ],
    "@baseType": null,
    "@schemaLocation": null,
    "@type": null
}
string
id
Optional

The identifier of the task

string
href
Optional

A reference to the task

string
state
Optional

Current state of the operation task

array of object
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.

object
comment
Optional

Indicates the comments entered on the alarm.

array of object
commentedAlarm
Optional

The successfully commented alarms

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


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 -H 'Authorization: <value>' https://{api_host}/tcsa/api/tmf/v1/commentAlarms/{id}