Get Audit Trail

Get Audit Trail

This API returns the audit trails of the notification.

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

Request to get audit trail of a notification.

AuditRequest of type(s) application/json
Required

Show optional properties

{
    "deDupKey": "Name:NOTIFICATION-Switch_SDIRouter4_Down__200601$Source:INCHARGE-SA-PRES4$",
    "source": "INCHARGE-SA-PRES4",
    "firstNotifiedAt": 1614687329000
}
{
    "deDupKey": "Name:NOTIFICATION-KubernetesWorker_KubernetesWorker-96105fd2-1a74-46b6-ac8f-e869609e8d42_Down$Source:INCHARGE-SA-PRES$",
    "source": "INCHARGE-SA-PRES",
    "firstNotifiedAt": 1660934327000,
    "sort": [
        {
            "order": "desc",
            "fieldName": "Severity"
        }
    ],
    "vsafilter": {
        "condition": "AND",
        "filterlist": [
            "Filter Object"
        ]
    },
    "from": 0,
    "size": 0
}
string
deDupKey
Required

deDupKey, uniquely identifies the notification across domains.

string
source
Required

The origin source of the notification. If source is not defined in notification, pass an empty value "".

number
firstNotifiedAt
Required

The timestamp of notification, when it was first notified.

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.

integer
from
Optional

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

integer
size
Optional

The size parameter allows you to configure the maximum amount of records to be returned. Defaults to 50.

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns AuditResponse of type(s) application/json
{
    "Count": 0,
    "Result": [
        {
            "User": "DXA",
            "ActionType": "NOTIFY",
            "SerialNumber": 0,
            "Text": "Server: INCHARGE-SA",
            "Timestamp": 1660934341000,
            "DeDupKey": "string",
            "Customer": "string",
            "AuditId": "string"
        }
    ]
}
integer
Count
Optional

Total number of audit-trail records present

array of AuditTrail
Result
Optional

An array of audit trail objects.


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; that is, it is Client must authenticate itself to get the requested response

Operation doesn't return any data structure

404

The server can not find the requested resource

Operation doesn't return any data structure