Photo by Markus Winkler on Unsplash

Export Data Slice EPM REST API

In today’s article, lets have a closer look at the Export Data Slice EPM REST API. To read more about EPM REST APIs head over to Oracle’s documentation.

I have created few videos on my YouTube channel explaining EPM REST APIs concepts. You can view those here.

API Details

Export data slice can be used to export data for a specified region or intersection . The exported data will be in the form of a JSON grid with pov, columns, and 0 or more data rows. Data will be exported only for cells for which the user has read-write access.

  • Method : POST
  • Response: JSON
  • End point: /HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/exportdataslice

You have to provide the following details to the end point:

  • API Version
  • Application Name
  • Plan Type / cube name

Payload Parameters

The API accepts a payload with the below parameters. The details of the parameters are provided in the table below.

The key parameter is the gridDefinition parameter. This is what we use to define our grid (pov, columns and rows).

Grid Definition Example

Let’s check out a form in FCCS to understand the grid definition more clearly. I will be working with the FCCS_Balance Sheet by Consolidation data form.

To define a grid we need 3 basic components : POV, Columns and Rows. Let’s just focus on the first column and one account on the row. Based on these assumptions the dimensions for the grid definition are as follows.

  • POV: Movement, Years, Period, Data Source, Scenario, Entity, View, Intercompany, Multi-GAAP, Product
  • Column: Consolidation, Currency
  • Row: Account

Below image shows the POV dimensions and the corresponding members

For Column we will be using the below dimensions and corresponding members

  • Consolidation: FCCS_Entity Total
  • Currency: Entity Currency

For Column we will be using the below dimensions and corresponding members

  • Account: FCCS_Total Assets

Grid Definition Payload

Now that we have seen the grid we are working with lets convert the grid definition into JSON format so that we can use it as a payload with the REST API request.

The POV section is as follows:

The column section is as follows:

The row section is as follows:

You can download the final JSON payload file here.

Invoking the REST API

The final piece of the puzzle is to invoke the REST API. You can check out the Python example here. The below code snippet shows you how to invoke the REST API. The key is the “data” parameter which is the JSON payload information with the grid definition.

After successfully invoking the REST API you should see the JSON response like below.

Conclusion

Once you understand the concept of grid definition it is fairly easy to use the Export data Slice REST API. You can also include multiple columns and rows in the grid definition. I will be creating a YouTube video showing you this example. If you have any questions let me know.

--

--

Get the Medium app

A button that says 'Download on the App Store', and if clicked it will lead you to the iOS App store
A button that says 'Get it on, Google Play', and if clicked it will lead you to the Google Play store