List Alarm

List Alarm

This operation lists or finds Alarm entities How to apply filter: The filtering mechanism is implemented in the query of the URL itself. However there is no specific query parameter named 'filter'.

The filtering is based on using name value query parameters on entity attributes. The basic expression is a sequence of attribute assertions being ANDED to formulate a filtering expression:

  • GET {apiRoot} /{resourceName}?[{attributeName}={attributeValue}&*]

For examples:

  • GET /tcsa/api/tmf/v1/alarms?ackState=ACKNOWLEDGED&alarmRaisedTime=2022-09-14T04:56:08Z

Here the the filter applied specifies that the alarms returned should have its ackState as ACKNOWLEDGED and should have been raised on 022-09-14T04:56:08Z.

The above mechanism is only for attribute value equality. Attribute values ORING is supported and is achieved by providing a filtering expression where the same attribute name is duplicated a number of times with different values. For example:

  • GET /tcsa/api/tmf/v1/alarms?ackState=ACKNOWLEDGED&ackState=UNACKNOWLEDGED

Here the filter applied specifies that the alarms returned should have ackState as either ACKNOWLEDGED or UNACKNOWLEDGED.

Alternatively ORING can also be achieved by comma separating the attribute values. [{attributeName}={attributeValue},{ attributeValue }*]. For example:

  • GET /tcsa/api/tmf/v1/alarms?ackState=ACKNOWLEDGED,UNACKNOWLEDGED
Request
URI
GET
https://{api_host}/tcsa.host.com/tcsa/api/tmf/v1/alarms
COPY
Query Parameters
string
fields
Optional

Comma-separated properties to be provided in response

fields example 
id
integer
offset
Optional

Requested index for start of resources to be provided in response

integer
limit
Optional

Requested number of resources to be provided in response

limit example 
10
string
sort
Optional

sort contains the following query parameters:

  • Sort-Query-Parameters : “sort”, “=”, (Sort-Direction), Sort-Field

where:

  • Sort-Direction : “-“ or “+”
  • Sort-Field: The field to sort on.

The default direction is Ascending order, the use of the modifier in front of the sort field name, “-“, changes the sort order direction. For example:

  • ?sort=name (Sorts the result set on the name.)
  • ?sort=-name (Sorts the result set on the name in descending order.)

Furthermore multiple attribute names can be specified by separating the names with commas. The sorting order will be specified from the left to right order of the fields listed. For example:

  • ?sort= [attributeName],...,[attributeName]

Nested resource attributes can be specified as:

  • [parentResource].[childResource].[attributeName]

Complete example:

  • GET /tcsa/api/tmf/v1/alarms?sort=alarmRaisedTime,perceivedSeverity
  • GET /tcsa/api/tmf/v1/alarms?sort=-alarmRaisedTime,perceivedSeverity (Descending)
sort example 
alarmRaisedTime
Authentication
This operation uses the following authentication methods.
Responses
200

Success

Returns Array of Alarm of type(s) application/json 
[
    {
        "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": [],
        "id": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Unresponsive$Source:INCHARGE-SA-PRES2$",
        "href": "/tcsa/api/tmf/v1/alarms/Name%3ANOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Unresponsive%24Source%3AINCHARGE-SA-PRES2%24",
        "ackState": "UNACKNOWLEDGED",
        "alarmChangedTime": "2022-08-02T12:53:41Z",
        "alarmClearedTime": null,
        "alarmDetails": "Indicates that all of the system's IPv4 and IPv6 addresses not responding and the SNMPAgent is not responding as well. ",
        "alarmRaisedTime": "2020-08-27T08:03:03Z",
        "alarmReportingTime": "2022-10-25T08:09:12.161Z",
        "alarmType": "Unresponsive",
        "alarmedObjectType": "Router",
        "isRootCause": false,
        "perceivedSeverity": "UNKNOWN",
        "plannedOutageIndicator": "OUT_OF_SERVICE",
        "sourceSystemId": "AMPMNEWUS23000",
        "state": "ACTIVE",
        "alarmedObject": {
            "id": "AMPMNEWUS23000_PS_Router_267$Router$INCHARGE-SA-PRES2",
            "href": "/tcsa/api/topology/v1/instances/AMPMNEWUS23000_PS_Router_267%24Router%24INCHARGE-SA-PRES2",
            "@baseType": "alarm",
            "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
            "@type": "notification"
        },
        "comment": [
            {
                "systemId": null,
                "comment": "Server: INCHARGE-SA-AGG2",
                "time": "2022-08-02T12:53:30Z",
                "userId": "DXA",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification"
            },
            {
                "systemId": null,
                "comment": "Server: INCHARGE-SA-AGG2",
                "time": "2022-08-02T12:47:14Z",
                "userId": "DXA",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification"
            },
            {
                "systemId": null,
                "comment": "INCHARGE-SA-AGG2: ICS initialization",
                "time": "2022-08-02T12:45:56Z",
                "userId": "SYSTEM",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification"
            },
            {
                "systemId": null,
                "comment": "Server: INCHARGE-SA-AGG2",
                "time": "2022-01-31T13:22:13Z",
                "userId": "DXA",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification"
            },
            {
                "systemId": null,
                "comment": "Server: INCHARGE-SA-AGG2",
                "time": "2022-01-31T13:16:48Z",
                "userId": "DXA",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification"
            },
            {
                "systemId": null,
                "comment": "INCHARGE-SA-AGG2: ICS initialization",
                "time": "2022-01-31T13:14:32Z",
                "userId": "SYSTEM",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification"
            },
            {
                "systemId": null,
                "comment": "Server: INCHARGE-SA-AGG2",
                "time": "2021-03-02T09:11:06Z",
                "userId": "DXA",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification"
            }
        ],
        "parentAlarm": [
            {
                "id": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__2_Down$Source:INCHARGE-SA-PRES2$",
                "href": "/tcsa/api/alarms/Name%3ANOTIFICATION-Router_AMPMNEWUS23000__PS__Router__2_Down%24Source%3AINCHARGE-SA-PRES2%24",
                "name": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__2_Down$Source:INCHARGE-SA-PRES2$",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification",
                "@referredType": "null"
            },
            {
                "id": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Down$Source:INCHARGE-SA-PRES2$",
                "href": "/tcsa/api/alarms/Name%3ANOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Down%24Source%3AINCHARGE-SA-PRES2%24",
                "name": "Name:NOTIFICATION-Router_AMPMNEWUS23000__PS__Router__267_Down$Source:INCHARGE-SA-PRES2$",
                "@baseType": "alarm",
                "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
                "@type": "notification",
                "@referredType": "null"
            }
        ],
        "@baseType": "alarm",
        "@schemaLocation": "https://developer.vmware.com/apis/telco-cloud-service-assurance/latest",
        "@type": "notification"
    }
]

Response Headers

integer
X-Total-Count

Total number of items matching criteria

integer
X-Result-Count

Actual number of items returned in the response body


400

Bad Request

Returns Error of type(s) application/json 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
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 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
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 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
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 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
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 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
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 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
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 
{
    "code": "string",
    "reason": "string",
    "message": "string",
    "status": "string",
    "referenceError": "string",
    "@baseType": "string",
    "@schemaLocation": "string",
    "@type": "string"
}
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.


On This Page
Tmf Alarms Operations
POST
Create Ack Alarms
POST
Create Alarm
POST
Create Clear Alarms
POST
Create Comment Alarms
POST
Create Un Ack Alarms
DELETE
Delete Alarm
GET
List Ack Alarms
GET
List Alarm
GET
List Clear Alarms
GET
List Comment Alarms
GET
List Un Ack Alarms
PATCH
Patch Alarm
GET
Retrieve Ack Alarms
GET
Retrieve Alarm
GET
Retrieve Clear Alarms
GET
Retrieve Comment Alarms
GET
Retrieve Un Ack Alarms