Export Query Results

When exporting all Essbase data, there is an option for writing the output in columnar format, and columnar-formatted data can be filtered by level-0 dimension members. This API triggers a job that can be monitored in the Job Library.

Required Roles

Service Administrator, Power User, User, Viewer

REST Resource

POST /epm/rest/{api_version}/applications/{application}/jobs/exportQueryResultsJob

Request

Supported Media Types: application/json

The following table summarizes the client request.

Table 24-17 Parameters

Name	Description	Type	Required	Default
`api_version`	Version of the API you are developing with, such as `v1`	Path	Yes	None
`application`	Name of the application	Path	Yes	None
`exportOnlyLevel0Flg`	Whether to export only Level0 data; values are `true` or `false`	Payload	No	false
`fileName`	Name of the query output file to be exported into the Outbox folder	Payload	Yes	None
`fileOutputOptions`	File output options. Available options are: `ZIP_ONLY` `ZIP_AND_TEXT` `TEXT_ONLY`	Payload	No	`ZIP_ONLY`
`queryName`	Query name from the Profitability and Cost Management application When `queryName` has a value, results for the given query are exported; `exportOnlyLevel0Flg` is considered if it is included. When `queryName` is blank or not included, data for the entire application is exported. In this case, `exportOnlyLevel0Flg` is ignored.	Payload	No	None
`roundingPrecision`	The rounding precision (decimal places) for exported data. (Note: Applies only if `queryName` is also used.)	Payload	No	2
`dataFormat`	Select the output format as native Essbase format, or as columnar format. Values are `NATIVE` or `COLUMNAR`. With the `COLUMNAR` option, all Essbase data is exported, so the `queryName` parameter is ignored. Data can be filtered using the `memberFilters` parameter.	Payload	No	NATIVE
The following parameters are only considered when `dataFormat=COLUMNAR`.
`memberFilters`	Accepts a JSON formatted string for dimension and respective level-0 member format. For example: `{\"Dim1\":[\"Mem1\"],\"Dim2\":[\"Mem21\",\"Mem22\"]}`	Payload	No	None
`includeHeader`	Adds dimension names as column headers. Values are `true` or `false`.	Payload	No	true
`delimiter`	Character used to separate dimension members in the results file; must be enclosed in double quotes.	Payload	No	Space
`keepDuplicateMemberFormat`	When this parameter is set to `true`, prints member names in Essbase duplicate member format, such as [Account]@[Accoun1]. If set to `false`, only the member name is printed.	Payload	No	true

Example URL and Payload

https://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/Ex3F3/jobs/exportQueryResultsJob

{"queryName":"Profitability - Product","fileName":"ProfitabilityProduct_03232016.txt","exportOnlyLevel0Flg":"true","roundingPrecision":"3"}

Response Body

Supported Media Types: application/json

Table 24-18 Parameters

Name	Description
`details`	Task ID, such as `BksML12_BksML12_ExportQueryResults_D20160323T024820_f73_1`
`status`	See Migration Status Codes
`statusMessage`	Message about the status, such as `In Progress`
`type`	Profitability
`data`	Parameters as key value pairs
`links`	Detailed information about the link
`href`	Links to API call
`action`	The HTTP call type
`rel`	Relationship type
`data`	Parameters as key value pairs passed in the request

Example of Response Body

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

{
   "type":"Profitability",
   "status":-1,
   "statusMessage":"In Progress",
   "details":"BksML30_ExportQueryResults_D20220511T114843_935",
   "links":[
      {
         "href":"http:// <SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/epm/rest/v1/applications/jobs/ChecktaskStatusJob/BksML30_ExportQueryResults_D20220511T114843_935",
         "action":"GET",
         "rel":"Job Status"
      }
   ]
}