Execute Reports for Data Management

The Data Management reporting framework represents a unified solution that incorporates source and target data, templates, and user-defined SQL queries. Templates, created in Oracle Business Intelligence Publisher, consume data in XML format and generate reports dynamically. You can add SQL queries to extract data from tables, or couple them with the report parameters to extend the definition of a standard report. Data Management reports can be generated as PDF, Excel, Word, or HTML output.

REST Resource

POST /aif/rest/{api_version}/jobs

Request

Supported Media Types: application/json

The following table summarizes the client request.

Table 9-7 Parameters

Name Description Type Required Default
api_version Version of the API you are working with, such as V1 Path Yes None
jobType The job type, REPORT Path Yes None
jobName

The name of the report to be executed, such as Dimension Map For POV (Dimension, Cat, Per)

Path Yes None
reportFormatType The file format of the report, pdf, xlsx, html, or excel Path Yes pdf
parameters Can vary in count and values based on the report Path Yes None
Location The location of the report, such as Comma_Vision Path Yes None

Example of Request Body

The following shows an example of the request body in JSON format.

{
"jobType":"REPORT",  
"jobName":"Dimension Map For POV (Dimension, Cat, Per)",
"reportFormatType":"PDF",
"parameters":{
  	 "Dimension Name":"ENTITY",
  	 "Category":"Actual",
   	 "Period":"Jan15",
  	 "Location":"Comma_Vision"
    }
}

For sample code, see the code samples included in Running Data Rules.

Response

The following table summarizes the response parameters.

Table 9-8 Parameters

Name Description

jobId

The process ID generated in Data Management for the job, such as 1885

status

The job status, such as RUNNING

logFileName

Log file containing entries for this execution, such as outbox\logs\BESSAPP-DB_1885.log

outputFileName

Name of the output file generated; you can use this name to download the report

processType

Type of process executed, EXECUTE_REPORT

executedBy

Login name of the user used to execute the rule, such as admin

details

Returns the exception stack trace in case of an application error, or null

Supported Media Types: application/json

Parameters

Example of Response Body

The following shows an example of the response body in JSON format.

{
"links": 
[
0]
"status":"-1",
"details":"null",
"jobId":"1885",
"jobStatus":"RUNNING",
"logFileName":"outbox/logs/1885.log",
"outputFileName":"outbox/reports",
"processType":"EXECUTE_REPORT",
"executedBy":"admin"
}

For sample code, see the code samples included in Running Data Rules.