Export Notifications

Export Notifications

This API exports notifications that are matched with given filter to csv file.

Request
URI
POST
https://{api_host}/tcsa.host.com/tcsa/api/notification-management/v1/notifications/export
COPY
Request Body

Filter to export notifications.

NotificationExportFilter of type(s) application/json
Required 
{
    "vsafilter": {
        "condition": "AND",
        "filterlist": [
            {
                "condition": "AND",
                "propfilter": [
                    {
                        "propname": "IsLiveNotification",
                        "matchtype": "MATCH",
                        "values": [
                            "true"
                        ]
                    }
                ]
            }
        ]
    },
    "from": 0,
    "size": 5492,
    "sort": [
        {
            "fieldName": "LastChangedAt",
            "order": "desc"
        }
    ],
    "startTimestamp": 1717213680000,
    "endTimestamp": 1719373740000
}
VsaFilter
vsafilter
Optional

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

integer
size
Optional

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

integer
from
Optional

The from parameter defines the offset from the first result you want to fetch.

array of Sort
sort
Optional

The Sort object defines, on which field sorting has to be apply and what will be the sorting order (ASC/DESC).

number
startTimestamp
Optional

Must be in EPOCH milli seconds.

number
endTimestamp
Optional

Must be in EPOCH milli seconds.

Authentication
This operation uses the following authentication methods.
Responses
200

notifications in csv format

"\"Severity\",\"Acknowledged\",\"Owner\",\"Class Name\",\"Name\",\"Event Name\",\"Event State\",\"Notification Source\",\"Impact\",\"Occurrence Count\",\"Last Changed\",\"Active\",\"Category\",\"Certainty\",\"Class Display Name\",\"Clear On Acknowledge\",\"Element Class Name\",\"Element Name\",\"Event Text\",\"Event Type\",\"First Notified\",\"In Maintenance\",\"Instance Name\",\"Notification\",\"Is Problem\",\"Is Root\",\"Last Cleared\",\"Last Notified\",\"Source Event Type\",\"Source Info\",\"Ticket ID\",\"UserDefined 1\",\"UserDefined 10\",\"UserDefined 11\",\"UserDefined 12\",\"UserDefined 13\",\"UserDefined 14\",\"UserDefined 15\",\"UserDefined 16\",\"UserDefined 17\",\"UserDefined 18\",\"UserDefined 19\",\"UserDefined 2\",\"UserDefined 20\",\"UserDefined 3\",\"UserDefined 4\",\"UserDefined 5\",\"UserDefined 6\",\"UserDefined 7\",\"UserDefined 8\",\"UserDefined9\",\"Source\",\"Event Display Name\",\"Notification DisplayName\",\"UUID\",\"tags.location\",\"tags.customer\"\n\"3\",\"true\",\"SYSTEM\",\"VirtualMachine\",\"vmbased-demodeploy-manju-DeployerVM1\",\"GuestOSNotRunning\",\"INACTIVE\",\"INCHARGE-ESM-SamsungVDU-USM\",\"0\",\"2\",\"1719380518000\",\"false\",\"Operational\",\"100.0\",\"VirtualMachine\",\"false\",\"VirtualMachine\",\"VM-wdc-11-vc20.oc.vmware.com:vmbased-demodeploy-manju-DeployerVM1\",\"no description available\",\"DURABLE\",\"1719379059000\",\"false\",\"VM-wdc-11-vc20.oc.vmware.com:vmbased-demodeploy-manju-DeployerVM1\",\"NOTIFICATION-VirtualMachine_VM-wdc-11-vc20.oc.vmware.com_:vmbased-demodeploy-manju-DeployerVM1_GuestOSNotRunning\",\"true\",\"true\",\"1719380214000\",\"1719379724000\",\"PROBLEM\",\"INCHARGE-SA\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"\",\"INCHARGE-SA-PRES\",\"GuestOSNotRunning\",\"VirtualMachine GuestOSNotRunning 100.0%: vmbased-demodeploy-manju-DeployerVM1\",\"Name:NOTIFICATION-VirtualMachine_VM-wdc-11-vc20.oc.vmware.com_:vmbased-demodeploy-manju-DeployerVM1_GuestOSNotRunning$Source:INCHARGE-SA-PRES$\",\"\",\"\""

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

On This Page
Notification Operations
POST
Ack Notifications
POST
Action On Notifications
POST
Add Audit Logs
POST
Export Notifications
POST
Get Audit Trail
POST
Get Caused By
POST
Get Causes
POST
Get Distinct Values Of Notification Property
POST
Get Max Severity For Devices
POST
Get Notification History
POST
Get Notifications
POST
Get Notification Summary
POST
Get Server Tools
POST
Notification Count
POST
Perform Server Tools Actions
POST
Release Ownership
POST
Take Ownership
POST
Threshold List
POST
Unack Notifications