EPM Cloud REST API Compatibility

These tables summarize the compatibility for Oracle Enterprise Performance Management Cloud REST APIs.

NOTE: These abbreviations are used in the column headings: PLN (Planning), FF (FreeForm), SWP (Strategic Workforce Planning), SP (Sales Planning), FCC (Financial Consolidation and Close), AR (Account Reconciliation), EPCM (Enterprise Profitability and Cost Management), PCM (Profitability and Cost Management), and TR (Tax Reporting)

For detailed information about REST APIs, see Quick Reference Table – REST API Resource View.

EPM Platform

Table 3-1 EPM Platform

EPM Platform Tasks PLN, FF, SWP, SP FCC AR EPCM PCM TR
Execute a Report Bursting Definition Yes Yes   Yes   Yes
Update a Connection Yes Yes   Yes   Yes
View a Connection Yes Yes   Yes   Yes
View all Connections Yes Yes   Yes   Yes

Planning, FreeForm, Strategic Workforce Planning, and Sales Planning

Table 3-2 Planning, FreeForm, Strategic Workforce Planning, and Sales Planning

Planning, FreeForm, Strategic Workforce Planning, and Sales Planning Tasks PLN, FF, SWP, SP FCC AR EPCM PCM TR
Getting API Versions for Planning Yes Yes   Yes   Yes
Get Information about a Specific REST API Version for Planning Yes Yes   Yes   Yes
Get Job Definitions Yes Yes   Yes   Yes
Execute a Job Yes Yes   Yes   Yes
Retrieve Job Status Yes Yes   Yes   Yes
Retrieve Job Status Details Yes Yes   Yes   Yes
Retrieve Child Job Status Details Yes Yes   Yes   Yes
Add Member Yes Yes   Yes   Yes
Get Member Yes Yes   Yes   Yes
Get Applications Yes Yes   Yes   Yes
List All Planning Units Yes Yes        
Get Planning Unit History and Annotations Yes Yes        
Get a Planning Unit Owner Photo Yes Yes        
Get Planning Unit Promotional Path Yes Yes        
Get Available Planning Unit Actions Yes Yes        
Get Filters with All Possible Values Yes Yes   Yes    
Change Planning Unit Status Yes Yes        
Get User Preferences Yes Yes   Yes   Yes
Import Data Slice Yes Yes   Yes   Yes
Export Data Slice Yes Yes   Yes   Yes
Clear Data Slice Yes Yes   Yes   Yes
Get All Substitution Variables Defined for the Application Yes Yes   Yes   Yes
Get a Substitution Variable Defined for the Application Yes Yes   Yes    
Create or Update All Substitution Variables Defined for the Application Yes Yes   Yes    
Get Substitution Variables Defined at the Plan Type Level Yes Yes   Yes    
Get Derived Substitution Variables at the Plan Type Level Yes Yes   Yes    
Get a Derived Substitution Variable Defined at the Plan Type Level Yes Yes   Yes    
Delete a Substitution Variable at the Plan Type Level Yes Yes   Yes    
Delete a Substitution Variable for the Application Yes Yes   Yes    
Delete Substitution Variables at the Plan Type Level Yes Yes   Yes    
Delete Substitution Variables for the Application Yes Yes   Yes    

Migration

Table 3-3 Migration

Migration Tasks PLN, FF, SWP, SP FCC AR EPCM PCM TR
             
Migration Status Codes Yes Yes Yes Yes Yes Yes
Get REST API Versions for Migration Yes Yes Yes Yes Yes Yes
Get Information about a Specific Version of Migration Sample Code Yes Yes Yes Yes Yes Yes
Import and Export Files
LCM Import (v1) Yes Yes Yes Yes Yes Yes
LCM Import (v2) Yes Yes Yes Yes Yes Yes
LCM Export (v1) Yes Yes Yes Yes Yes Yes
LCM Export (v2) Yes Yes Yes Yes Yes Yes
Upload and Download Files
Upload Yes Yes Yes Yes Yes Yes
Download Yes Yes Yes Yes Yes Yes
View and Delete Files
List Files (v11.1.2.3.600) Yes Yes Yes Yes Yes Yes
List Files (v2) Yes Yes Yes Yes Yes Yes
Delete Files (v11.1.2.3.600) Yes Yes Yes Yes Yes Yes
Delete Files (v2) Yes Yes Yes Yes Yes Yes
Delete Files (v3) Yes Yes Yes Yes Yes Yes
Manage Services
Get Information About All Services Yes Yes Yes Yes Yes Yes
Get Idle Session Timeout Yes Yes Yes Yes Yes Yes
Set Idle Session Timeout Yes Yes Yes Yes Yes Yes
Restart the Service Instance (v1) Yes Yes Yes Yes Yes Yes
Restart the Service Instance (v2) Yes Yes Yes Yes Yes Yes
Run Recreate on a Service (11.1.2.3.600) Yes Yes Yes Yes Yes Yes
Run Recreate on a Service (v2) Yes Yes Yes Yes Yes Yes
Manage Application Snapshots
Get Information About All Application Snapshots Yes Yes Yes Yes Yes Yes
Get Information about a Specific Application Snapshot Sample Code Yes Yes Yes Yes Yes Yes
Upload Application Snapshot (v1) Yes Yes Yes Yes Yes Yes
Upload Application Snapshot (v2) Yes Yes Yes Yes Yes Yes
Download Application Snapshot (v1) Yes Yes Yes Yes Yes Yes
Download Application Snapshot (v2) Yes Yes Yes Yes Yes Yes
Copy Application Snapshot (v1) Yes Yes Yes Yes Yes Yes
Copy Application Snapshot (v2) Yes Yes Yes Yes Yes Yes
Rename Application Snapshot (v1) Yes Yes Yes Yes Yes Yes
Rename Application Snapshot (v2) Yes Yes Yes Yes Yes Yes
Copy to and from the Object Store
Copy to Object Store (v1) Yes Yes Yes Yes Yes Yes
Copy to Object Store (v2) Yes Yes Yes Yes Yes Yes
Copy from Object Store (v1) Yes Yes Yes Yes Yes Yes
Copy from Object Store (v2) Yes Yes Yes Yes Yes Yes
Working with Oracle Essbase
Export Essbase Data (v2) Yes Yes   Yes   Yes
Essbase Block Analysis Report Yes Yes       Yes
Get Essbase Query Governor Execution Time Yes Yes   Yes   Yes
Set Essbase Query Governor Execution Time Yes Yes   Yes   Yes
Other            
Copy a File Between Instances (v1) Yes Yes Yes Yes Yes Yes
Copy a File Between Instances (v2) Yes Yes Yes Yes Yes Yes
Clone an Environment Yes Yes Yes Yes Yes Yes
List Backups - Only for OCI (Gen 2) Environments Yes Yes Yes Yes Yes Yes
Restore Backup - Only for OCI (Gen 2) Environments Yes Yes Yes Yes Yes Yes
Provide Feedback (v11.1.2.3.600) Yes Yes Yes Yes Yes Yes
Provide Feedback (v2) Yes Yes Yes Yes Yes Yes
Send Email (v1) Yes Yes Yes Yes Yes Yes
Send Email (v2) Yes Yes Yes Yes Yes Yes
Skip Updates (v1) Yes Yes Yes Yes Yes Yes
Skip Updates (v2) Yes Yes Yes Yes Yes Yes

Usage Simulation

Table 3-7 Usage Simulation

Data Integration Tasks PLN, FF, SWP, SP FCC AR EPCM PCM TR
Simulate Concurrent Usage Yes Yes       Yes

Account Reconciliation

Table 3-11 Account Reconciliation

Account Reconciliation Tasks PLN, FF, SWP, SP FCC AR EPCM PCM TR
Get API Versions for Account Reconciliation REST APIs     Yes      
Get Information about a Specific API Version for Account Reconciliation REST APIs     Yes      
Retrieve Job Status for a Report     Yes      
Generate Report for Account Reconciliation     Yes      
Generate User Details Report for Account Reconciliation     Yes      
Export Application Properties     Yes      
Import Application Properties     Yes      
Export Background Image     Yes      
Import Background Image     Yes      
Export Logo Image     Yes      
Import Logo Image     Yes      
Create a Connection     Yes      
View All Connections     Yes      
Update a Connection     Yes      
Delete a Connection     Yes      
Set Application Access Level     Yes      
Retrieve Application Access Level     Yes      
Execute a Job in Account Reconciliation     Yes      
Retrieve Periods with a Specific Status     Yes      
Create Reconciliation (Reconciliation Compliance)     Yes      
Change Period Status (Reconciliation Compliance)     Yes      
Import Pre-Mapped Balances (Reconciliation Compliance)     Yes      
Import Pre-Mapped Transactions (Reconciliation Compliance)     Yes      
Import Balances (Reconciliation Compliance)     Yes      
Import Profiles (Reconciliation Compliance)     Yes      
Import Rates (Reconciliation Compliance)     Yes      
Import Reconciliation Attributes (Reconciliation Compliance)     Yes      
Import Attribute Values     Yes      
Monitor Reconciliations (Reconciliation Compliance)     Yes      
Retrieve Job Status (Reconciliation Compliance)     Yes      
View Reconciliation Comments     Yes      
Import Pre-Mapped Transactions (Transaction Matching)     Yes      
Run Auto Match (Transaction Matching)     Yes      
Purge Transactions (Transaction Matching)     Yes      
Archive Matched Transactions (Transaction Matching)     Yes      
Purge Archived Transactions (Transaction Matching)     Yes      
Unmatch Matched Transactions (Transaction Matching)     Yes      
Retrieve Job Status (Transaction Matching)     Yes      
Update Unmatched Transactions (Transaction Matching)     Yes      

Task Manager

Table 3-13 Task Manager

Task Manager Tasks PLN, FF, SWP, SP FCC AR EPCM PCM TR
Update Task Status for Event Monitoring   Yes       Yes
Create a Connection   Yes       Yes
Delete a Connection   Yes       Yes
Update a Connection   Yes       Yes
View All Connections   Yes       Yes
Deploy Task Manager Templates   Yes       Yes

Supplemental Data Manager

Table 3-14 Supplemental Data Manager

Supplemental Data Manager Tasks PLN, FF, SWP, SP FCC AR EPCM PCM TR
Deploy Form Templates   Yes        
Import Supplemental Collection Data for Financial Consolidation and Close   Yes        

Enterprise Profitability and Cost Management

Table 3-17 Enterprise Profitability and Cost Management

Enterprise Profitability and Cost Management Tasks PLN, FF, SWP, SP FCC AR EPCM PCM TR
Getting API Versions for Enterprise Profitability and Cost Management       Yes    
Calculate Model       Yes    
Clear Data By Point of View       Yes    
Copy Data by Point of View       Yes    
Delete Point of View       Yes    
Generate Model Documentation Report       Yes    
Validate Model       Yes    

Profitability and Cost Management