10 Planning REST APIs

Use the Planning REST APIs to get the REST API version, manage and execute jobs, and work with members, applications, planning units, user preferences, data slices, substitution variables, and user variables.

Note:

You can also use these APIs with FreeForm.

Table 10-1 Planning REST APIs

Planning REST APIs
Delete a Substitution Variable at the Plan Type Level	Delete Substitution Variables at the Plan Type Level	Delete a Substitution Variable for the Application
Delete Substitution Variables for the Application	Get Applications	Get Application Summary
Get Dimensions for a Plan Type	Get Dimension Details	Get Plan Types
Get User Preferences	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
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
List Library Documents	Execute a Job	Get Job Definitions
Retrieve Job Status	Retrieve Job Status Details	Retrieve Child Job Status Details
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
Change Planning Unit Status	Get Planning Unit History and Annotations	Get a Planning Unit Owner Photo
Get Planning Unit Promotional Path	Get Available Planning Unit Actions	Get Filters with All Possible Values
List All Planning Units	Clear Data Slices	Import Data Slices
Export Data Slices	Export Data	Export Form Data
Add Member	Get Member

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

• message
• localizedMessage