3 Cloud EPM Platform
Use this table for common Planning functional-area APIs from Dimensions, Jobs, and Data Slices. These APIs provide shared patterns for Planning-compatible business processes, including Planning and FreeForm.
Table 3-1 Common Platform REST APIs
| Functional Area | Common API | Applies To | Use when you need to |
|---|---|---|---|
| Applications | Get Applications | Planning, Freeform | Get a list of appliations |
| Get Application Summary | Planning, Freeform | Get a comprehensive, AI focused markdown of the specified business process application. | |
| Data Slices | Clear Data Slice | Planning, Freeform | Clear Planning and Essbase data for a specified region. |
| Export Data | Planning, Freeform | Export the data. | |
| Export Form Data | Planning, Freeform | Export the form data. | |
| Export Data Slice | Planning, Freeform | Export the data slice. | |
| Import Data Slice | Planning, Freeform | Import a data slice. | |
| Dimensions | Add Member | Planning, Freeform | Add a new member |
| Get Dimensions for a Plan Type | Planning, Freeform | Get dimensions for a plan type. | |
| Get Dimension Details | Planning, Freeform | Get dimension details. | |
| Get Member | Planning, Freeform | Get the specified member properties. | |
| Get Plan Types | Planning, Freeform | Retrieve the plan types. | |
| Documents | List Library Documents | Planning, Freeform | List the library documents. |
| Jobs | Get Job Definitions | Planning, Freeform | Get job definitions |
| Execute a Job | Planning, Freeform | Execute a job. | |
| Retrieve Job Status | Planning, Freeform | Retrieve a job status. | |
| Retrieve Job Status Details | Planning, Freeform | Retrieve the job status details. | |
| Retrieve Child Job Status Details | Planning, Freeform | Retrieve child job status details. | |
| Planning Units | Change Planning Unit Status | Planning, Freeform | Change the status of the planning units. |
| Get Available Planning Unit Actions | Planning, Freeform | Get the list of available planning unit actions. | |
| Get a Planning Unit Owner Photo | Planning, Freeform | Get a Planning Unit Owner Photo. | |
| Get Filters with All Possible Values | Planning, Freeform | Get filters with all possible values. | |
| Get Planning Unit History and Annotations | Planning, Freeform | Get the planning unit history and annotations. | |
| Get Planning Unit Promotional Path | Planning, Freeform | Get the planning unit promotional path. | |
| List All Planning Units | Planning, Freeform | List all the planning units. | |
| Substitution Variables | Create or Update All Substitution Variables Defined for the Application | Planning, Freeform | Create or update substitution variables for the application. |
| Delete a Substitution Variable at the Plan Type Level | Planning, Freeform | Delete a substitution variable defined at the plan type level. | |
| Delete a Substitution Variable for the Application | Planning, Freeform | Delete a substitution variable for the application. | |
| Delete a User Variable | Planning, Freeform | Delete a user variable. | |
| Delete Substitution Variables at the Plan Type Level | Planning, Freeform | Delete substitution variables defined at the plan type level. | |
| Delete Substitution Variables for the Application | Planning, Freeform | Delete substitution variables for the application. | |
| Get a Derived Substitution Variable Defined at the Plan Type Level | Planning, Freeform | Get a derived substitution variable defined at the plan type level. | |
| Get a Substitution Variable Defined for the Application | Planning, Freeform | Get a substitution variable defined for the application. | |
| Get All Substitution Variables Defined for the Application | Planning, Freeform | Get all substitution variables defined for the application. | |
| Get Derived Substitution Variables at the Plan Type Level | Planning, Freeform | Get derived substitution variables at the plan type level. | |
| Get Substitution Variables Defined at the Plan Type Level | Planning, Freeform | Get substituion variables defined at the plan type level. | |
| User Preferences | Get User Preferences | Planning, Freeform | Return the display preferences. |
| User Variables | Create User Variables | Planning, Freeform | Create user variables to help filter the members. |
| Get All User Variables | Planning, Freeform | Get all user variables | |
| Set the User Variable Values for the Application | Planning, Freeform | Set the user variable values for the application. | |
| Update User Variables | Planning, Freeform | Update the user variables. | |
| Get User Variable Values Defined for the Application | Planning, Freeform | Retrieve the user variables defined for the application. | |
| Get User Variable Values Defined for the Application by the User Name | Planning, Freeform | Retrieve the user variables defined for the application by the user name. | |
| Get User Variable Values Defined in the Application by the User Name and Value | Planning, Freeform | Retrieve the user variables defined for the application by the user name.and value. | |
| Get User Variable Values Defined in the Application by the User Variable Name | Planning, Freeform | Retrieve the user variable values defined in the application by the user variable name. | |
| Get User Variable Values Defined in the Application by Value | Planning, Freeform | Retrieve the user variable values defined in the application by value. | |
| Get a User Variable Using Its ID | Planning, Freeform | Retrieve a user variable using it's ID. | |
| Delete User Variable Definitions | Planning, Freeform | Delete user variable definitions. | |
| Versions | Get Information about a Specific REST API Version for Planning | Planning, Freeform | Get information about a specific API version. |
| Getting API Versions for Planning | Planning, Freeform | Get API versions |