Export Form Data

Use this AI REST API to export data as a JSON grid for a slice defined by a specified Planning form.

Note:

Requires an Oracle Fusion Cloud deployment with AI Studio.

This REST API is ideal when you want to extract data using a form (by name or ID), especially when the full member intersection is not known in advance or when the form is asymmetric.

Required Roles

Any Role

REST Resource

GET       /HyperionPlanning/rest/v3/applications/{application}/forms/{idorname}/data

Request

Supported Media Types: application/json

Parameters

The following table summarizes the client request.

Table 8-91 Parameters

Name	Description	Type	Required	Default
application	The name of the application	Path	Yes	None
idorname	ID or name of the form that defines the slice to export	Path	Yes	None
pageMbrList	List of page member names for which data is exported	Query	No	None
displayMemberAs	Controls how member headers are displayed (values from DisplayMemberAs)	Query	No	None
memberAliasDelimiter	Delimiter between member and alias (for "Then" display options)	Query	No	:
forceStartExpanded	If true, forces all rows and columns to be expanded. If false, the forceStartExpanded for dimension will be applied.	Query	No	False
filterMembers	List of member values used to further filter the form	Query	No	None
fields	Comma-separated list of field names to be returned.	Query	No	All fields

Example URL

https://<BASE-URL>/HyperionPlanning/rest/v3/applications/<APPLICATION>/forms/<FORM_ID_OR_NAME>/data?page=<PAGE_MEMBER_1>&page=<PAGE_MEMBER_2>&displayMemberAs=<DISPLAY_MEMBER_AS>&forceStartExpanded=<TRUE_FALSE>&fields=<FIELDS_LIST>

Note:

For new forms, first call the endpoint with fields=gridInfo,pov to discover the grid structure. Then make a second call requesting rows/columns (and applying filters/expansion flags) as needed.

Response

Supported Media Types: application/json

Parameters

The following table summarizes the parameters.

Table 8-92 Parameters

Name	Description
gridInfo	Provides metadata about the grid layout, including page, row, and column dimensions and allowed page members.
pageDimNames	List of dimension names on the page axis.
allowedPageMembersByDim	Map of page dimension name to the list of allowed page members for that dimension.
rowDimNames	List of dimension names on the row axis.
columnDimNames	List of dimension names on the column axis.
rows	Row data returned by the form slice.
headers	Row header member(s) for the row (for example, account).
data	Data values for the row aligned to the columns returned.
columns	Column header where each entry represents the member combination for a column (for example, Year, Scenario,Version).

Sample Response

{
  "gridInfo": {
    "pageDimNames": ["Product"],
    "allowedPageMembersByDim": { "Product": ["Total Product", "Widget", "Gadget"] },
    "rowDimNames": ["Account"],
    "columnDimNames": ["Year", "Scenario", "Version"]
  },
  "pov": {
    "Year": "FY25",
    "Scenario": "Plan",
    "Version": "Working"
  },
  "rows": [
    { "headers": ["Sales"], "data": [12345, 23456] },
    { "headers": ["COGS"], "data": [3456, 4567] }
  ],
  "columns": [
    ["FY25", "Plan", "Working"],
    ["FY26", "Forecast", "Final"]
  ]
}