JDBC Driver for Workday

Build 24.0.9062

ActivityLogging

Retrieves a collection of user activity log entries in a specified time frame.

Workday Resource Information

Retrieves all user activity log entries in a specified time frame. You can filter the log entries by user and task.

The from and to parameters are required.

To tune the performance and to ensure that you retrieve the complete set of records in a time period, iteratively call the GET /activityLogging endpoint with the following recommended parameter values:

* limit=1000 (Note that the maximum value of the limit parameter has been increased from 100 to 1000.)

* offset=0 (Initially set to 0, then increment by 1000 in subsequent runs.)

* instancesReturned=1 (A lower value is more performant. The value of 1 fetches 10,000 records.)

Examples of iterative calls:
GET /activityLogging?from=2022-04-17T08:15:00Z&to=2022-04-17T09:15:00Z&limit=1000&instancesReturned=1&offset=0
GET /activityLogging?from=2022-04-17T08:15:00Z&to=2022-04-17T09:15:00Z&limit=1000&instancesReturned=1&offset=1000
GET /activityLogging?from=2022-04-17T08:15:00Z&to=2022-04-17T09:15:00Z&limit=1000&instancesReturned=1&offset=2000

For more details, see the User Activity Logging REST API Guide in the Administrator Guide.

Secured by: System Auditing

Scope: System

Columns

Name Type Description
ActivityAction String Supported for: SELECT. The type of action that was executed.
DeviceType String Supported for: SELECT. The device type from the user signon used to make the request.
IpAddress String Supported for: SELECT. The user's IP Address from the user signon used to make the request.
RequestTime Datetime Supported for: SELECT. The request time of the action.
SessionId String Supported for: SELECT. The system ID for tracking signons from the user signon used to make the request.
SystemAccount String Supported for: SELECT. The system account that initiated the request.
Target_Descriptor String Supported for: SELECT. A description of the instance
Target_Href String Supported for: SELECT. A link to the instance
Target_Id String Supported for: SELECT. wid / id / reference id
TaskDisplayName String Supported for: SELECT. The action executed in the transaction.
TaskId String Supported for: SELECT. The Workday ID of the task executed in the transaction.
UserActivityEntryCount Decimal Supported for: SELECT. Returns the User Activity Count for the inputted filter parameters
UserAgent String Supported for: SELECT. The client browser and operating system information from the user signon used to make this request.
From_Prompt Date (Required) The date and time of the earliest log entry. The default timezone is UTC/GMT. The time format is "{yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}Z". Example: "2021-05-18T13:45:14Z" indicates May 18, 2021, 1:45PM UTC.
InstancesReturned_Prompt Long This number multiplied by 10,000 determines the total number of requested user activity instances. Example: A value of 5 requests a maximum of 50,000 instances. The default and maximum values are 25. By default, the method requests the maximum 250,000 instances. To fine-tune the performance, set this parameter to a lower number. While the instancesReturned parameter controls the total number of requested instances, the limit parameter controls the number of returned instances in a paginated response.
ReturnUserActivityEntryCount_Prompt Bool If true, returns only the total count of user activity instances for the specified parameters.
SystemAccount_Prompt String No description available.
TaskId_Prompt String No description available.
To_Prompt Date (Required) The date and time of the latest log entry. The default timezone is UTC/GMT. The time format is "{yyyy}-{mm}-{dd}T{hh}:{mm}:{ss}Z". Example: "2021-05-18T13:45:14Z" indicates May 18, 2021, 1:45PM UTC.

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9062