Get Distinct Values Of Notification Property

This API returns the distinct values of live notifications for a property, provided as query param {property_name}. If user wants to get the distinct values for a set of notification instead of all notification, user can pass filter in the request payload.

Request

URI

POST

https://{api_host}/tcsa/api/notification-management/v1/notifications/properties/{property_name}/distinct

COPY

Path Parameters

string

property_name

Required

name of the property

property_name example

Severity

Request Body

Request to get distinct property values.

NotificationDistinctValueRequest of type(s) application/json

Required

{
    "vsafilter": {
        "filterlist": [
            {
                "propfilter": [
                    {
                        "propname": "Name",
                        "matchtype": "REGEX",
                        "values": [
                            "NOTIFICATION-CPU.*"
                        ]
                    }
                ]
            }
        ]
    }
}

object

vsafilter

Optional

The VSAFilter object defines how the filters has to be applied on queries.

integer

size

Optional

Constraints: default: 50

The size parameter allows you to configure the maximum no of records to be returned.

Authentication

This operation uses the following authentication methods.

bearerAuth

Responses

200

Returns Array of object of type(s) application/json

"DistinctNotificationValueResponse Object"

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

401

Client must authenticate itself to get the requested response

Operation doesn't return any data structure

403

The client does not have access rights to the content.

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/tcsa/api/notification-management/v1/notifications/properties/{property_name}/distinct

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Notification Operations

POST

Get Notifications