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

Applications
Get Applications	Get Application Summary
Data Slices
Clear Data Slice	Export Data	Export Form Data
Export Data Slice	Import Data Slice
Dimensions
Add Member	Get Dimensions for a Plan Type	Get Dimension Details
Get Member	Get Plan Types
Documents
List Library Documents
Jobs
Get Job Definitions	Execute a Job	Retrieve Child Job Status Details
Retrieve Job Status Details
Planning Units
Change Planning Unit Status	Get Available Planning Unit Actions	Get a Planning Unit Owner Photo
Get Filters with All Possible Values	Get Planning Unit History and Annotations	Get Planning Unit Promotional Path
List All Planning Units
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	Delete a User Variable	Delete User Variable Definitions
Set the User Variable Values for the Application	Get All User Variables	Get User Variable Values Defined for the Application
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	Get User Variable Values Defined in the Application by the User Variable Name
Get User Variable Values Defined in the Application by Value	Get a User Variable Using Its ID	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