Export Data Slices

Can be used to export data for a specified region. 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.

REST Resource

POST /HyperionPlanning/rest/{api_version}/applications/{application}/plantypes/{plantype}/exportdataslice

Request

Supported Media Types: application/json

Parameters:

The following table summarizes the client request.

Table 5-63 Parameters

Name Description Type Required Default
api_version Version of the API you are developing with Path Yes None
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://<SERVICE_NAME>-<TENANT_NAME>.<SERVICE_TYPE>.<dcX>.oraclecloud.com/HyperionPlanning/rest/v3/applications/Vision/plantypes/plan1/exportdataslice

Payload Parameters

The Payload is JSON with the following parameters.

Table 5-64 Parameters

Name Description
gridDefinition JSON grid definition to define the region
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.
suppressMissingBlocks True or false. Optionally, you can set suppressMissingBlocks to true to suppress blocks with missing data.
suppressMissingRows True or false. Optionally, you can set suppressMissingRows to true to suppress rows with missing data.
suppressMissingColumns True or false. Optionally, you can set suppressMissingColumns to true to suppress rows with missing data.

Supported Media Type: application

Sample Payload

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



{
   "exportPlanningData": false,
   "gridDefinition": {
      "suppressMissingBlocks": true,
      "pov": {
         "dimensions": [
            "HSP_View",
            "Year",
            "Scenario",
            "Version",
            "Entity",
            "Product"
         ],
         "members": [
            [
               "BaseData"
            ],
            [
               "FY15"
            ],
            [
               "Plan"
            ],
            [
               "Working"
            ],
            [
               "410"
            ],
            [
               "P_160"
            ]
         ]
      },
      "columns": [
         {
            "dimensions": [
               "Period"
            ],
            "members": [
               [
                  "IDescendants(Q1)"
               ]
            ]
         },
         {
            "dimensions": [
               "Period"
            ],
            "members": [
               [
                  "IDescendants(Q2)"
               ]
            ]
         }
      ],
      "rows": [
         {
            "dimensions": [
               "Account"
            ],
            "members": [
               [
                  "Project Number",
                  "Request Date",
                  "Project Type",
                  "Project Investment"
               ]
            ]
         }
      ]
   }
}

OR

No dimension names provided is less efficient:



{
   "exportPlanningData": true,
   "gridDefinition": {
      "suppressMissingBlocks": true,
      "pov": {
         "members": [
            [ "BaseData" ], [ "FY15" ], [ "Plan"],[ "Working" ],["410" ],["P_160" ]
         ]
      },
      "columns": [
         {
            "members": [
               [
                  "IDescendants(Q1)"
               ]
            ]
         },
         {
            "members": [
               [ "IDescendants(Q2)" ]
            ]
         }
      ],
      "rows": [
         {
            "members": [
               [
                  "Project Number",
                  "Request Date",
                  "Project Type",
                  "Project Investment"
               ]
            ]
         }
      ]
   }
}

JSON Output

The following shows an example of the response body with exportPlanningData : true.



{
   "pov": [
      "BaseData",
      "FY15",
      "Plan",
      "Working",
      "410",
      "P_160"
   ],
   "columns": [
      [
         "Jan",
         "Feb",
         "Mar",
         "Q1",
         "Apr",
         "May",
         "Jun",
         "Q2"
      ]
   ],
   "rows": [
      {
         "headers": [
            "Project Number"
         ],
         "data": [
            "1",
            "2",
            "3",
            " ",
            " ",
            " ",
            " ",
            " "
         ],
         "cellNotes": [
            [
               {
                  "contents": "Internal Project<br/>"
               },
               {
                  "contents": "Project delayed<br/>"
               }
            ],
            [],
            [],
            [],
            [],
            [],
            [],
            []
         ]
      },
      {
         "headers": [
            "Request Date"
         ],
         "data": [
            "",
            "",
            "",
            "",
            "",
            "",
            "",
            ""
         ]
      },
      {
         "headers": [
            "Project Type"
         ],
         "data": [
            "Other",
            "IT",
            "Construction",
            "",
            "",
            "",
            "",
            ""
         ]
      },
      {
         "headers": [
            "Project Investment"
         ],
         "data": [
            "100000",
            "110000",
            "200000",
            "410000",
            "",
            "",
            "",
            ""
         ],
         "cellNotes": [
            [],
            [
               {
                  "contents": "Internal + External investments made here.<br/>"
               }
            ],
            [],
            [],
            [],
            [],
            [],
            []
         ],
         " supportingDetail": [
            null,
            {
               "items": [
                  {
                     "value": "60000",
                     "position": 0,
                     "label": "Internal",
                     "generation": 0,
                     "operator": "+"
                  },
                  {
                     "value": "50000",
                     "position": 1,
                     "label": "External",
                     "generation": 0,
                     "operator": "+"
                  }
               ]
            },
            null,
            null,
            null,
            null,
            null,
            null
         ]
      }
   ]
}

Example 2: Suppress missing blocks, rows, and columns when exporting a data slice:



{
   "exportPlanningData": false,
   "gridDefinition": {
      "suppressMissingBlocks": true,
      "suppressMissingRows": true,
      "suppressMissingColumns": true,
      "pov": {
         "dimensions": [
            "HSP_View",
            "Year",
            "Scenario",
            "Version",
            "Entity",
            "Product"
         ],
         "members": [
            [
               "BaseData"
            ],
            [
               "FY15"
            ],
            [
               "Plan"
            ],
            [
               "Working"
            ],
            [
               "410"
            ],
            [
               "P_160"
            ]
         ]
      },
      "columns": [
         {
            "dimensions": [
               "Period"
            ],
            "members": [
               [
                  "IDescendants(Q1)"
               ]
            ]
         },
         {
            "dimensions": [
               "Period"
            ],
            "members": [
               [
                  "IDescendants(Q2)"
               ]
            ]
         }
      ],
      "rows": [
         {
            "dimensions": [
               "Account"
            ],
            "members": [
               [
                  "Project Number",
                  "Request Date",
                  "Project Type",
                  "Project Investment"
               ]
            ]
         }
      ]
   }
}

JSON Output:



{
   "pov": [
      "BaseData",
      "FY15",
      "Plan",
      "Working",
      "410",
      "P_160"
   ],
   "columns": [
      [
         "Jan",
         "Feb",
         "Mar",
         "Q1",
         "Apr",
         "May",
         "Jun",
         "Q2"
      ]
   ],
   "rows": [
      {
         "headers": [
            "Project Number"
         ],
         "data": [
            "1",
            "2",
            "3",
            " "
         ]
      },
      {
         "headers": [
            "Project Type"
         ],
         "data": [
            "Other",
            "IT",
            "Construction",
            ""
         ]
      },
      {
         "headers": [
            "Project Investment"
         ],
         "data": [
            "100000",
            "110000",
            "200000",
            "410000"
         ]
      }
   ]
}