9 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
Data Slices
Clear Data Slice Export Data Slice	Export Data Import Data Slice	Export Form Data
Dimensions
Add Member Get Member	Get Dimensions for a Plan Type Get Plan Types	Get Dimension Details
Documents
List Library Documents
Jobs
Get Job Definitions Retrieve Job Status Details	Execute a Job	p
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
Substituion Variables
List All Planning Units List All Planning Units List All Planning Units List All Planning Units	List All Planning Units List All Planning Units List All Planning Units	List All Planning Units List All Planning Units List All Planning Units
User Preferences
Get User Preferences
User Variables
Create User Variables Set the User Variable Values for the Application Get User Variable Values Defined for the Application by the User Name Get User Variable Values Defined in the Application by Value	Delete a User Variable Get All User Variables Get User Variable Values Defined in the Application by the User Name and Value Get a User Variable Using Its ID	Delete User Variable Definitions Get User Variable Values Defined for the Application Get User Variable Values Defined in the Application by the User Variable Name Update User Variables
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