Export Audit

Exports the audit records to a Comma Separated Values (CSV) file. The generated CSV file is compressed and the output is a zip file.

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request specific to this job. For parameters that are generic to all jobs, see Execute a Job.

Table 5-26 Parameters

Name Description Required Default
jobType Export Audit Yes None
jobName The job name to be used for this job execution. Example: ExportAudit No Export Audit
userNames Comma separated user names. Audit records created by only the specified users are exported. If not specified, audit records created by all users are exported. No None
fileName

The name of the file to which records should be exported. The file containing the exported data is stored in the Oracle Planning and Budgeting Cloud repository.

If fileName is not specified, a file is auto-generated with a name containing the user name, current date, and time stamp. For example, test_admin_AuditRecords_2019-02-26-04-34-45-420.zip

No The file name is auto-generated
nDays Number of days for which audit records should be exported.

Possible values are.

  • 1: Export audit records for the last 24 hours
  • 2: Export audit records for the last two days
  • 7: Export audit records for the last seven days
  • 30: Export audit records for the last 30 days
  • 60: Export audit records for the last 60 days
  • 180: Export audit records for the last 180 days
  • All: Export all audit records
No 7

Notes:

  • This job does not export records based on group names.
  • If a user name contains a comma, escape the comma in the request. For example, if a user name is test,User then add test\\,User to the request.

Sample Payload

Example 1: Exports the last 180 days of audit records to the ExportAuditLast180Days.zip file.

{
    "jobType": "Export Audit",
    "jobName": "Export180DaysAudit",
    "parameters": {
        "fileName": "ExportAuditLast180Days.zip",
	      "ndays": "180"
    }
}

Example 2: Exports the last seven days of audit records created by planner1 and planner2. Records are exported to a zip file with an auto-generated file name.

{
    "jobType": "Export Audit",
    "jobName": "AllAuditRecordsOfPlanners",
    "parameters": {
	     "userNames": "planner1, planner2"
    }
}