Export Job Console
Use this REST API to export the job console records to a Comma Separated Values (CSV) file.
The output CSV file contains the first character as a Byte Order Mark (BOM) character,
\ufeff
. The API writes an encrypted application identifier
following the BOM character. This application identifier is written between
double-quotes. Headers for the CSV file follow the application identifier.
You can use an optional excludeApplicationId
parameter to not write the application identifier in the export file. Exported job console data files without the application identifier cannot be imported back into the application.
The generated CSV file is compressed and the output is a ZIP file. The file can be downloaded using the Download REST API.
To view pending jobs, see Viewing Pending Jobs and Recent Activity.
Using this REST API requires prerequisites, such as understanding how to use jobs. See Prerequisites. Be sure that you understand how to use jobs as described in Managing Jobs.
Required Roles
Service Administrator
Request
Supported Media Types: application/json
Parameters
The following table summarizes the client request parameters specific to this job. For additional parameters that are common to all jobs, see Execute a Job.
Table 8-27 Parameters
Name | Description | Required | Default |
---|---|---|---|
jobType |
Export Job Console | Yes | None |
jobName |
The job name to be used for this job execution. Example: ExportWeeklyJobStatusRecords |
No | Export Job Console |
userNames |
Comma separated user names. Job console records created by only the specified users are exported. If not specified, job console 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 Planning repository. If |
No | The file name is auto-generated |
ndays |
Number of days for which audit records should be exported.
Possible values are.
|
No | 7 |
jobNames |
Comma-separated job names for which job console records should be exported. | No | None |
jobTypes |
Comma-separated job codes for which job console records should be exported.
Possible values are:
|
No | Rules |
jobStatusCodes |
Comma-separated status code of the jobs for which job records are exported. Possible values are:
|
No | 2 |
exportErrorDetails |
If true, exports the details of failed/error jobs as separate error log file in the final output file. Job status details of jobs having one of the status listed below are exported in separate files.
|
No | true |
topCountDuration |
Filters the top n job status records by completion time. This is useful for finding the longest running jobs. For example, enter
|
No |
0 Represents all records |
excludeApplicationId |
Optionally, you can specify if the application identifier should be written in the export file. Possible values: This parameter can benefit those customers who do not want the application identifier to be included in the export file to help import into their own systems. This export file cannot be used to import into an EPM Cloud environment. |
No | false |
For a sample URL, see Sample URL and Payload in Execute a Job.
Sample Payload
Example 1: Exports the job console records for all default parameters into the NewFile.csv
file. Exports status of all Rule jobs completed in the last seven days.
{
"jobType":"JOBCONSOLE_EXPORT",
"jobName":"AllJobConsoleExports",
"parameters":{"fileName":"NewFile.csv"}
}
Example 2: Exports the job console records for Rule and Export Data jobs that completed normally or with an error status over the last month into the exportFile.csv
file. Job details of the failed jobs are exported in separate files in the final compressed file.
{
"jobType":"JOBCONSOLE_EXPORT",
"parameters":{"fileName":"exportFile.csv", "jobTypes": "Rules, EXPORT_DATA", "jobStatusCodes": "2,3", "ndays":"30"}
}
Example 3: Exports the job console records for the jobs named Daily Consolidation and Smart Push to a Reporting Cube. Includes jobs that completed normally or with an error status over the last month into the exportFile.csv
file. Job details of the failed jobs are not exported in separate files because exportErrorDetails
is false
.
{
"jobType":"JOBCONSOLE_EXPORT",
"parameters":{"fileName":"exportFile.csv", "jobNames":"Daily Consolidation, Smart Push to Reporting Cube", "jobStatusCodes": "2,3", "ndays":"30", "exportErrorDetails":"false"}
}
Example 4: Exports the top 10 longest running jobs:
{
"jobType":"JOBCONSOLE_EXPORT",
"parameters":{"fileName":"exportFile.csv", "jobStatusCodes": "all",
"ndays":"all", "jobTypes":"all", "exportErrorDetails":"false",
"topCountDuration":"10"}
}
Example 5: Exports the job console records for all default parameters into to the NewFile.csv
file. This exports status of all Rule jobs completed in the last seven days. The application identifier will be not written in the generated file. This export file cannot be used to import into an EPM Cloud environment.
{
"jobType":"JOBCONSOLE_EXPORT",
"jobName":"AllJobConsoleExports",
"parameters":{
"fileName":"NewFile.csv",
"excludeApplicationId": "true"
}