Audit Events Resource

Endpoints under /auditevent provide access to audit events—Waterline Data system and user activities. You can use audit event characteristics such as user, date, or type of activity to filter the events returned.
Audit events are available only to users with an Administrator role.

GET /v2/auditevent/list

This method has been deprecated.

A GET request to the /auditevent/list endpoint returns a fixed number of audit events, sorted by descending dates.

Request Parameters
name type description default constraints
from query The index of the first audit event; "0" indicates the audit event for the most recent activity. 0 int
size query The number of audit events to return; if not specified, size defaults to 25. 25 int
Response Body
media type data type description
application/json AuditEventListResponse (JSON) A list of AuditEvent objects in JSON format.

Example

Request
GET /v2/auditevent/list
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "auditEvents" : [ {
    "impactedObject" : "...",
    "user" : "...",
    "auditAction" : "...",
    "impactedObjectName" : "...",
    "state" : "...",
    "key" : "...",
    "type" : "...",
    "description" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "restricted" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "customProperties" : [ {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    }, {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    } ]
  }, {
    "impactedObject" : "...",
    "user" : "...",
    "auditAction" : "...",
    "impactedObjectName" : "...",
    "state" : "...",
    "key" : "...",
    "type" : "...",
    "description" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "restricted" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "customProperties" : [ {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    }, {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    } ]
  } ],
  "from" : 12345,
  "size" : 12345,
  "total" : 12345
}
                
              

POST /v2/auditevent/search

A POST request to the /auditevent/search endpoint returns a fixed number of audit events, sorted by descending dates.

Request Parameters
name type description default constraints
from query The index of the first audit event; "0" indicates the audit event for the most recent activity. 0 int
size query The number of audit events to return; if not specified, size defaults to 25. 25 int
Request Body
media type data type description
application/json AuditFilterCriteria (JSON) AuditFilterCriteria
Response Body
media type data type description
application/json AuditEventListResponse (JSON) A list of AuditEvent objects in JSON format.

Example

Request
POST /v2/auditevent/search
Content-Type: application/json
Accept: application/json

                
{
  "resourceKey" : "ra4b85dfe685844fb3",
  "fromTime" : 1533160527980,
  "toTime" : 1533160527989,
  "username" : "wlddev",
  "inputKeyword" : "rae08c9b033dcc4fde 3-Letter_Country_Code SUCCESS",
  "auditAction" : "Associated a tag"
}
                
              
Response
HTTP/1.1 201 Created
Content-Type: application/json

                
{
  "auditEvents" : [ {
    "impactedObject" : "...",
    "user" : "...",
    "auditAction" : "...",
    "impactedObjectName" : "...",
    "state" : "...",
    "key" : "...",
    "type" : "...",
    "description" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "restricted" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "customProperties" : [ {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    }, {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    } ]
  }, {
    "impactedObject" : "...",
    "user" : "...",
    "auditAction" : "...",
    "impactedObjectName" : "...",
    "state" : "...",
    "key" : "...",
    "type" : "...",
    "description" : "...",
    "timeOfLastChange" : 12345,
    "timeOfCreation" : 12345,
    "restricted" : [ "...", "..." ],
    "updateable" : [ "...", "..." ],
    "viewAble" : [ "...", "..." ],
    "customProperties" : [ {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    }, {
      "displayName" : "...",
      "value" : { },
      "description" : "...",
      "facetAble" : true,
      "name" : "...",
      "type" : "..."
    } ]
  } ],
  "from" : 12345,
  "size" : 12345,
  "total" : 12345
}
                
              

GET /v2/auditevent/{key}

A GET request to the auditevent/{key} endpoint returns a specific audit event.

Request Parameters
name type description
key path The unique identifier of an audit event.
Response Body
media type data type description
application/json AuditEvent (JSON) The AuditEvent object in JSON format.

Example

Request
GET /v2/auditevent/{key}
Content-Type: */*
Accept: application/json

                
...
                
              
Response
HTTP/1.1 200 OK
Content-Type: application/json

                
{
  "impactedObject" : "...",
  "user" : "...",
  "auditAction" : "...",
  "impactedObjectName" : "...",
  "state" : "...",
  "key" : "...",
  "type" : "...",
  "description" : "...",
  "timeOfLastChange" : 12345,
  "timeOfCreation" : 12345,
  "restricted" : [ "...", "..." ],
  "updateable" : [ "...", "..." ],
  "viewAble" : [ "...", "..." ],
  "customProperties" : [ {
    "displayName" : "...",
    "value" : { },
    "description" : "...",
    "facetAble" : true,
    "name" : "...",
    "type" : "..."
  }, {
    "displayName" : "...",
    "value" : { },
    "description" : "...",
    "facetAble" : true,
    "name" : "...",
    "type" : "..."
  } ]
}