Export Data

Note:

Requires an Oracle Fusion Cloud deployment with AI Studio.

This REST API is designed for programmatic export of large or complex datasets such as analytics, budgets, and forecasts. The request explicitly defines POV (point of view), column, and row axes, including dimensions and member segments; members are cross-joined within segments to form the output cells. Data will be exported only for cells for which the user has read or write access.

Required Roles

Any Role

REST Resource

POST /HyperionPlanning/rest/v3/applications/{application}/plantypes/{plantype}/exportdata

Request

Supported Media Types: application/json

Parameters:

Table 8-88 Parameters

Name	Description	Type	Required	Default
`application`	The name of the application for which to export the data slice	Path	Yes	None
`plantype`	Name of the plan type for which to export the data slice	Path	Yes	None

Example URL and Payload:

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/{application}/plantypes/{plantypes}/exportdata

Payload Parameters:

The Payload is JSON with the following parameters.

Table 8-89 Parameters

Name	Description
`exportPlanningData`	`True` or `False`. Optionally, you can provide the parameter exportPlanningData, which, when set to `true`, will export supporting details and cell notes along with Essbase numeric data. Default is `false`.
`formatPercentageAsPercent`	If `true`, formats numeric values between 0 and 1 as percent values (for example, `0.5` becomes `50%`).
`gridDefinition`	JSON grid definition to define the region
`suppressMissingBlocks`	True or false. Optionally, you can set `suppressMissingBlocks` to `true` to suppress blocks with missing data. Default is `false`.
`suppressMissingColumns`	True or false. Optionally, you can set `suppressMissingRows` to `true` to suppress rows with missing data. Default is `false`.
`suppressMissingRowsNative`	Enables native Essbase row suppression. If `true`, enables native row suppression in backend grid engine, default is `false`.
`suppressMissingSuppressesZero`	If `true`, treats zero values as missing for suppression, default is `false`.
`suppressInvalidScenarioTps`	Suppresses invalid scenario or time period (TP) intersections, default is `false`.
`suppressInvalidColumns`	Suppresses invalid columns from output, default is `false`.
`suppressInvalidRows`	Suppresses invalid rows from output, default is `false`.
`predictionSupportForDynCalcMbrs`	Enables data prediction for dynamic calc members if supported.
`autoCorrectSegments`	Automatically corrects segment formats as needed. Typically `true`.
`PovAxisDefinition`	Defines the POV axis (dimensions and members).
`ColumnAxisDefinition`	Defines the column axis (dimensions and segments).
`RowAxisDefinition`	Defines the row axis (dimensions and segments).

Sample Payload

Providing dimension names as follows in the gridDefinition is recommended and is more efficient.

{
  "exportPlanningData": false, 
  "formatPercentageAsPercent": true, 
  "gridDefinition": {
    "suppressMissingBlocks": true, 
    "suppressMissingRows": true, 
    "suppressMissingColumns": true, 
    "suppressMissingRowsNative": true, 
    "suppressMissingSuppressesZero": true,
    "suppressInvalidScenarioTps": true, 
    "suppressInvalidColumns": true, 
    "suppressInvalidRows": true, 
    "predictionSupportForDynCalcMbrs": true, 
    "autoCorrectSegments": true, 
    "PovAxisDefinition": {
      "dimensions": ["HSP_View", "Scenario", "Version", "Product"],
      "members": [ "BaseData", "Plan", "Working", "P_160" ]
    },
    "ColumnAxisDefinition": [
    {
      "dimensions": ["Year", "Period"],
      "segments": [
        [ ["FY20"], ["IDescendants(Q1)"] ]
      ] 
    }
    ],
    "RowAxisDefinition": [
    { 
      "dimensions": ["Entity", "Account"],
      "segments": [
       [ ["410"], ["Project Number"] ],
       [ ["420"], ["Request Date"] ],
       [ ["430"], ["Project Investment"] ]
      ]
     }
    ]
  }
}

Response

Supported Media Types: application/json

Returns a JSON object describing the exported grid, including POV, columns, rows, and when exportPlanningData is true, additional content such as cell notes and supporting detail (if available).