Export Data

Use this REST API to export application data into a file using the export data settings, including file name, specified in a job of type export data. The file containing the exported data is stored in the repository.

You can override some of the parameters of the job definition while executing this job with a REST API.

You can also export application data into a file using the parameter values provided, without an explicit predefined Export Data job definition.

Exporting data supports substitution variables. You can use substitution variables while providing the rowMembers, columnMembers, and povMembers definitions. See Exporting Data and Creating and Assigning Values to Substitution Variables in Administering Planning.

Required Roles

Service Administrator

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.

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-14 Export Data

Name	Description	Required	Default
jobType	Export Data or EXPORT_DATA (both parameters are supported)	Yes	None
jobName	The name of this job. Example: dailydataexport	No	Export Data
exportFileName	The file name for the exported data. Data is exported as a ZIP file only. The exported file is stored in the Planning repository. The value must use JSON syntax.	No	The file name for the exported data will be the same as jobName.
delimiter	Parameter to specify a delimiter. Allowed value is comma or tab.	No	comma
exportSmartListAs	Parameter to specify how Smart Lists are exported. Allowed value is label or name.	No	label, which signifies that Smart View labels will be exported.
includeDynamicMembers	Parameter to include or exclude dynamic members. Allowed value is true or false.	No	true, which signifies that dynamic members will be exported.
cube	Parameter to specify the cube from which to export data.	Yes	None
rowMembers	Parameter to specify the row members. Example: "Name,Price,Discount %"	Yes	None
columnMembers	Parameter to specify the column members. Example: "Name,Price,Discount %"	Yes	None
povMembers	Parameter to specify the POV members. Example: "Name,Price,Discount %"	Yes	None
exportDataDecimalScale	Parameter to specify the number of decimal positions (0-16) that will be returned when exporting data from Essbase. If the default None is selected, the data that is returned will not be formatted and will return as Essbase returns it. Selecting a numeric value will result in the exported data displaying that number of digits to the right of the decimal point, wherever applicable. For example, specifying 3 in the Decimals field will result in the exported data being formatted to display three digits to the right of the decimal point. Selecting 0 formats the data to display a whole number. Example: A value 27.07000001 can be formatted and written as 27.07 in the export data file if the value for this parameter is set to 2.	No	None

For a sample URL, see Sample URL and Payload in Execute a Job.

Sample Payloads

Example 1: Executes the export data job ExportJobDaily and overrides the exportFileName parameter.

{"jobType":"EXPORT_DATA","jobName":"ExportJobDaily",
     "parameters":{
          "exportFileName":"myExportfile.zip"
          }
}

Example 2: Executes the export data job ExportJobDaily and overrides the delimiter, exportSmartListAs, and includeDynamicMembers parameters.

{"jobType":"EXPORT_DATA","jobName":"ExportJobDaily",
"parameters":{
     "delimiter":"tab",
     "exportSmartListAs":"name",
     "includeDynamicMembers":"true"
     }

Example 3: Executes the export data job ExportJobDaily and overrides the cube parameter only. This job will now execute for the cube Vis1ASO.

{"jobType":"EXPORT_DATA","jobName":"ExportJobDaily",
"parameters":{
     "cube":"Vis1ASO
     }
}

Example 4: Executes the export data job ExportJobDaily and overrides the cube name along with the rowMembers, columnMembers, and povMembers parameters. This job will now execute for the cube Vis1ASO.

{"jobType":"EXPORT_DATA","jobName":"ExportJobDaily",
"parameters":{
     "cube":"Vis1ASO",
     "rowMembers":"Current,Variance,Actual,Scenario",
     "columnMembers":"Statistics,Account",
     "povMembers":"Period,Year,Version,Entity,Product,Channel"
     }
}

Example 5: Executes the export data job ExportJobDaily and overrides the cube name along with the parameters rowMembers, columnMembers, and povMembers. We use substitution variables while overriding the rowMembers, columnMembers, and povMembers definition. This job executes for the cube Vis1ASO.

{"jobType":"EXPORT_DATA","jobName":"ExportJobDaily",
 "parameters":{
     "cube":"Vis1ASO",
     "rowMembers":"ILvl0Descendants(&Param1)",
     "columnMembers":"ILvl0Descendants(&Param2)",
     "povMembers":"Period,Year,Version,&Param3,Product,Channel"
     }
}

Example 6: Executes the export data job ExportJobDaily and overrides the cube name along with the parameters exportDataDecimalScale, rowMembers, and columnMembers. We use substitution variables while overriding the rowMembers, columnMembers, and povMembers definition. This job executes for the cube Vis1ASO.

{"jobType":"EXPORT_DATA","jobName":"ExportJobDaily",
"parameters":{
     "cube":"Vis1ASO",
     "rowMembers":"ILvl0Descendants(&Param1)",
     "columnMembers":"ILvl0Descendants(&Param2)",
     "povMembers":"Period,Year,Version,&Param3,Product,Channel",
     "exportDataDecimalScale":"2"
     }
}

Example 7: Executes the export data job with all the mandatory parameters, cube, rowMembers, columnMembers, and povMembers. Default values are assumed for other non-mandatory parameters.

{"jobType": "EXPORT_DATA", 
"parameters": {
     "cube": "Vis1ASO",
     "rowMembers": "ILvl0Descendants(&Param1)",
     "columnMembers": "ILvl0Descendants(&Param2)",
     "povMembers": "Period,Year,Version,&Param3,Product,Channel"
     }
}

Example 8: Executes the export data job with all the mandatory parameters, cube, rowMembers, columnMembers, and povMembers. Decimal precision is set to 3. Default values are assumed for other non-mandatory parameters.

{"jobType": "EXPORT_DATA",
"parameters":{
     "cube": "Plan1",
     "rowMembers": "ILvl0Descendants(&Param1)",
     "columnMembers": "ILvl0Descendants(&Param2)",
     "povMembers": "Period,Year,Version,&Param3,Product,Channel",
     "exportDataDecimalScale": 3
     }
}

Example 9: Executes the export data job with all the mandatory parameters, cube, rowMembers, columnMembers, and povMembers. Decimal precision is set to 3. Dynamic members are not exported. Default values are assumed for all other non-mandatory parameters.

{"jobType": "EXPORT_DATA",
"parameters":{
     "cube": "Plan1",
     "rowMembers": "ILvl0Descendants(&Param1)",
     "columnMembers": "ILvl0Descendants(&Param2)",
     "povMembers": "Period,Year,Version,&Param3,Product,Channel",
     "exportDataDecimalScale": 3,
     "includeDynamicMembers": false
     }
}