9 Planning REST APIs

See URL Structure for information about the general URL structure for Planning REST APIs.

The Planning component supports both Infrastructure APIs and Platform APIs.

Note:

You can also use these REST APIs with FreeForm.

Table 9-1 Planning REST APIs

Applications
Get Applications Get Application Summary	Get Dimension Details Get User Preferences	List Library Documents
Data Slices
Clear Data Slice Import Data Slice	Export Data Slice Export Planning Data	Export Form Data
Jobs
Administration Mode Auto Predict Compact Cube Configure the Oracle Guided Learning (OGL) Server Clear Cube Cube Refresh Delete Library Documents Execute a Job Export Audit Export Cell-Level Security Export Application Data Export Job Console Export Security Execute a Report Bursting Definition	Export Application Data Export Job Console Export Security Execute a Report Bursting Definition Execute Application Diagnostics Export Library Documents Export Metadata Export User Variable Values Export Valid Intersections Get Job Definitions Import Cell-Level Security Import Data Import Exchange Rates Import Library Documents	Import Metadata Import Security Import User Variable Values Import Valid Intersections Merge Data Slices Optimize Aggregation Plan Type Map Restructure Cube Retrieve Job Status Retrieve Job Status Details Retrieve Child Job Status Details Rules Ruleset Sort Members
Members & Plan Types
Add Member Get Member	Get Dimensions for a Plan Type Get Plan Types	Inights Summary Get Insights
Planning Units
Change Planning Unit Status Get Filters with All Possible Values List All Planning Units	Get Available Planning Unit Actions Get Planning Unit History and Annotations	Get Planning Unit Owner Photo Get Planning Unit Promotional Path
User Variables & Substituion Variables
Get User Variable Values Defined for the Application Get User Variable Values Defined in the Application by the User Variable Name Get User Variable Values Defined in the Application by Value Get User Variable Values Defined for the Application by the User Name Get User Variable Values Defined in the Application by the User Name and Value Set the User Variable Values for the Application Create User Variables Delete a User Variable	Delete User Variable Definitions Get All User Variables Get a User Variable Using Its ID Update User Variables Delete a Substitution Variable at the Plan Type Level Delete a Substitution Variable for the Application Delete Substitution Variables at the Plan Type Level Delete Substitution Variables for the Application	Get All Substitution Variables Defined for the Application Get a Substitution Variable Defined for the Application Create or Update All Substitution Variables Defined for the Application Get Substitution Variables Defined at the Plan Type Level Get Derived Substitution Variables at the Plan Type Level Get a Substitution Variable Defined at the Plan Type Level Get a Derived Substitution Variable Defined at the Plan Type Level Create and Update Substitution Variables at the Plan Type Level
Versions
Get Information about a Specific REST API Version for Planning	Getting API Versions for Planning

Note: The following fields from the exception response in REST APIs for Planning and Planning Modules have been removed:

• message
• localizedMessage