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

Get Notifications

Description

Returns the list of notifications. By default maximum 10 records from offset 0 are returned in the response. In order to get the more or less number of records user can specify the desired number of records using “size” parameter.

Request

Request

URL

URL


post
https://{api_host}tcsa.host.com/tcsa/api/notification-management/v1/notifications
Copy

Request Body

Request Body

NotificationRequest of mimetype application/json Optional

Request body is optional. User needs to provide request body only when filtering, sorting or pagination is required.

{
    "from": 0,
    "size": 20
}
integer
from Optional

The from parameter defines the offset from the first result user want to fetch. Default is 0.


integer
size Optional

The size parameter allows you to configure the maximum amount of notifications to be returned. Default is 10.


array of Sort
sort Optional

The Sort object defines on how and which field sorting has to be applied.


vsafilter Optional

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

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns NotificationResponse of type application/json
{
    "Count": 10
}
integer
Count Optional

The total number of notification


array of Notification
Result Optional

An array of notfication objects.

Errors

Errors

401

Client must authenticate itself to get the requested response


403

The client does not have access rights to the content; that is, it is Client must authenticate itself to get the requested response


404

The server can not find the requested resource

Code Samples

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"from":0,"size":20}' https://{api_host}tcsa.host.com/tcsa/api/notification-management/v1/notifications


Feedback

Was this page helpful?