Get set admin audit data

This method enables users to retrieve the full list of actions carried out by EPM administrators in a specific set.

URL

Make sure there are no spaces in the URL.

The following characters are not supported in URL values: + & %

https://<EPM_Server>/EPM/API/<Version>/Sets/<setId>/AdminAudit

Resource information

HTTP method	Content type
GET	application/json

Header parameters

Parameter

Description

Authorization

Token generated in the EPM authentication or SAML authentication API.

Type: String

Valid value: basic <Token>

Mandatory: Yes

URL parameters

Parameter	Description
EPM_Server	EPM Server Type: String Valid value: EPM Server name (not dispatcher server name) Mandatory: Yes
Version	API version Type: String Valid value: Version number. Format is x.x.x.x (for example, 11.5.0.1) Default value: Latest version Mandatory: No
SetID	ID of a set that the user has permission to view, generated in the Get sets list API Type: String Valid value: Set ID Mandatory: Yes
DateFrom	Only include events since the given date Type: Date Valid values: ISO-8601 to format dates and UTC time zone - YYYY-MM-DDThh:mm:ssZ If DateFrom and DateTo are not set, only events from the last day are returned If only DateFrom is set, all events from that date are returned Mandatory: No
DateTo	Only include events until the given date Type: Date Valid values: ISO-8601 to format dates and UTC time zone - YYYY-MM-DDThh:mm:ssZ If DateFrom and DateTo are not set, only events from the last day are returned If only DateTo is set, all events until that date are returned Mandatory: No
Offset	Number of events to skip Type: Number Valid values: 0 (zero) or higher Default value: 0 Mandatory: No
Limit	Maximum number of events to return Type: Number Valid values: Higher than 0 (zero) Default value: 50 Mandatory: No

Example

The following example retrieves the full list of actions carried out by EPM administrators between May 26th, 2020, and May 28th, 2020, skipping the first 2 events, and returning the next 5 events.

https://<EPM_Server>/EPM/API/Sets/<SetId>/AdminAudit?datefrom=2020-05-26T08:00:00Z&dateto=2020-05-28T09:00:00Z&offset=2&limit=5

Result

{
    "TotalCount": <number>,
    "AdminAudits": [
        {
            "SetName": "<string>",
            "EventTime": "<time>",
            "PermissionDescription": "<string>",
            "Description": "<string>",
            "Feature": "<string>",
            "LoggedAt": "<time>",
            "LoggedFrom": "<IP address>",
            "Administrator": "<string>",
            "InternalSessionId": <session id>,
            "Role": <string>        },
    ]
}

AdminAudits

Parameter	Description
SetName	Set name
EventTime	The audit time
PermissionDescription	The permission needed by the admin in order to perform the activity
Description	The activity carried out by the administrator
Feature	The activity grouping
LoggedAt	The time when the administrator logged on
LoggedFrom	The IP address of the machine where the request was initiated
Administrator	The administrator's user name
InternalSessionId	The administrator login session id that is used for grouping activities in the session
Role	The role assigned to the administrator in this set

TotalCount

Parameter

Description

TotalCount

The total number of retrieved records that match the required filter

Type: Number

Return codes

For a complete list of return codes, see Return codes.