9 Planning REST APIs

The Planning component supports both Infrastructure APIs and Platform APIs.

Note:

You can also use these APIs with FreeForm.

Table 9-1 Planning REST APIs

REST API Planning FreeForm Consolidation Profitability Tax Reporting
Applications
Get Applications Yes Yes Yes Yes Yes
Get Application Summary Yes Yes Yes Yes Yes
Data Slices
Clear Data Slice Yes Yes Yes Yes Yes
Export Data Yes Yes Yes Yes Yes
Export Form Data Yes Yes Yes Yes Yes
Export Data Slice Yes Yes Yes Yes  
Import Data Slice Yes Yes Yes Yes Yes
Dimensions
Add Member Yes Yes Yes Yes Yes
Get Dimensions for a Plan Type Yes Yes Yes    
Get Dimension Details Yes Yes Yes    
Get Member Yes Yes Yes Yes Yes
Get Plan Types Yes Yes Yes    
Documents
List Library Documents Yes Yes Yes Yes Yes
Jobs
Get Job Definitions Yes Yes Yes Yes Yes
Execute a Job Yes Yes Yes Yes Yes
Retrieve Child Job Status Details Yes Yes Yes Yes Yes
Retrieve Job Status Details Yes Yes Yes Yes Yes
Planning Units
Change Planning Unit Status Yes Yes Yes    
Get Available Planning Unit Actions Yes Yes Yes    
Get a Planning Unit Owner Photo Yes Yes Yes    
Get Filters with All Possible Values Yes Yes Yes Yes  
Get Planning Unit History and Annotations Yes Yes Yes    
Get Planning Unit Promotional Path Yes Yes Yes    
List All Planning Units Yes Yes Yes    
Substitution Variables
Create or Update All Substitution Variables Defined for the Application Yes Yes Yes Yes  
Delete a Substitution Variable at the Plan Type Level Yes Yes Yes Yes  
Delete a Substitution Variable for the Application Yes Yes Yes Yes  
Delete Substitution Variables at the Plan Type Level Yes Yes Yes    
Delete Substitution Variables for the Application Yes Yes Yes    
Get a Derived Substitution Variable Defined at the Plan Type Level Yes Yes Yes Yes  
Get a Substitution Variable Defined for the Application Yes Yes Yes Yes  
Get All Substitution Variables Defined for the Application Yes Yes Yes Yes Yes
Get Derived Substitution Variables at the Plan Type Level Yes Yes Yes Yes  
Get Substitution Variables Defined at the Plan Type Level Yes Yes Yes Yes  
User Preferences
Get User Preferences Yes Yes Yes Yes Yes
User Variables
Create User Variables Yes Yes Yes   Yes
Delete a User Variable Yes Yes Yes   Yes
Delete User Variable Definitions Yes Yes Yes   Yes
Set the User Variable Values for the Application Yes Yes Yes Yes Yes
Get All User Variables Yes Yes Yes   Yes
Get User Variable Values Defined for the Application Yes Yes Yes Yes Yes
Get User Variable Values Defined for the Application by the User Name Yes Yes Yes Yes Yes
Get User Variable Values Defined in the Application by the User Name and Value Yes Yes Yes Yes Yes
Get User Variable Values Defined in the Application by the User Variable Name Yes Yes Yes Yes Yes
Get User Variable Values Defined in the Application by Value Yes Yes Yes Yes Yes
Get a User Variable Using Its ID Yes Yes Yes   Yes
Update User Variables Yes Yes Yes   Yes
Versions
Get Information about a Specific REST API Version for Planning Yes Yes Yes Yes Yes
Getting API Versions for Planning Yes Yes Yes Yes Yes

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

  • message
  • localizedMessage