Cloud EPM REST APIs at a Glance

This table lists all the available Oracle Fusion Cloud Enterprise Performance Management Platform REST APIs.

Note:

For a complete list of Account Reconciliation APIs, see Account Reconciliation APIs.

Table 1-1 REST APIs

REST API Planning FreeForm Consolidation Enterprise Profitability Tax Reporting
Infrastructure APIs: Managing Users, Groups, Roles, and Access Reports
Add Users to an Identity Domain (v1) Yes Yes Yes Yes Yes
Add Users to an Identity Domain (v2) Yes Yes Yes Yes Yes
Remove Users from an Identity Domain (v1) Yes Yes Yes Yes Yes
Remove Users from an Identity Domain (v2) Yes Yes Yes Yes Yes
Assign Users to an Application Role or Granular Role (v1) Yes Yes Yes Yes Yes
Assign Users to an Application Role or Granular Role (v2) Yes Yes Yes Yes Yes
Remove Users' Role Assignment (v1) Yes Yes Yes Yes Yes
Remove Users' Role Assignment (v2) Yes Yes Yes Yes Yes
Add Users to a Group (v1) Yes Yes Yes Yes Yes
Add Users to a Group (v2) Yes Yes Yes Yes Yes
Remove Users from a Group (v1) Yes Yes Yes Yes Yes
Remove Users from a Group (v2) Yes Yes Yes Yes Yes
List Users (v1) Yes Yes Yes Yes Yes
Update Users (v1) Yes Yes Yes Yes Yes
Update Users (v2) Yes Yes Yes Yes Yes
Add a User to a Batch of Groups (v1) Yes Yes Yes Yes Yes
Remove a User from a Batch of Groups (v1) Yes Yes Yes Yes Yes
Import User Group Assignments as CSV (v1) Yes Yes Yes Yes Yes
Update Granular Roles For Groups (v1) Yes Yes Yes Yes Yes
Update Granular Roles for Users (v1) Yes Yes Yes Yes Yes
Add Groups (v1) Yes Yes Yes Yes Yes
Add Groups (v2) Yes Yes Yes Yes Yes
List Groups (v1) Yes Yes Yes Yes Yes
Update Groups (v1) Yes Yes Yes Yes Yes
Remove Groups (v1) Yes Yes Yes Yes Yes
Remove Groups (v2) Yes Yes Yes Yes Yes
User Group Report (v1) Yes Yes Yes Yes Yes
User Group Report (v2) Yes Yes Yes Yes Yes
User Access Report (v1) Yes Yes Yes Yes Yes
User Access Report (v2) Yes Yes Yes Yes Yes
User Audit Report (v1) (Deprecated) Yes Yes Yes Yes Yes
User Audit Report (v2) (Deprecated) Yes Yes Yes Yes Yes
User Login Report (v1) Yes Yes Yes Yes Yes
Role Assignment Report (v1) Yes Yes Yes Yes Yes
Role Assignment Report for Users (v2) Yes Yes Yes Yes Yes
Role Assignment Report for Groups (v2) Yes Yes Yes Yes Yes
Get Available Roles (v2) Yes Yes Yes Yes Yes
Role Assignment Audit Report (v1) Yes Yes Yes Yes Yes
Invalid Login Report (v1) Yes Yes Yes Yes Yes
Group Assignment Audit Report (v2) Yes Yes Yes Yes Yes
Adding Users to a Team for Account Reconciliation (only ARCS)          
Adding Users to a Team for Financial Consolidation and Close and Tax Reporting     Yes    
Removing Users from a Team for Account Reconciliation (only ARCS)          
Removing Users from a Team for Financial Consolidation and Close and Tax Reporting     Yes    
Infrastructure APIs: Migration
Migration Status Codes Yes Yes Yes Yes Yes
Get REST API Versions for Migration Yes Yes Yes Yes Yes
LCM Import (v2) Yes Yes Yes Yes Yes
LCM Export (v2) Yes Yes Yes Yes Yes
Upload Yes Yes Yes Yes Yes
Download Yes Yes Yes Yes Yes
List Files (v2) Yes Yes Yes Yes Yes
Delete Files (v2) Yes Yes Yes Yes Yes
Delete Files (v3) Yes Yes Yes Yes Yes
Copy from Object Store (v1) Yes Yes Yes Yes Yes
Copy from Object Store (v2) Yes Yes Yes Yes Yes
Copy from Object Store (v3) Yes Yes Yes Yes Yes
Copy to Object Store (v1) Yes Yes Yes Yes Yes
Copy to Object Store (v2) Yes Yes Yes Yes Yes
Copy To Object Store (v3) Yes Yes Yes Yes Yes
Copy to SFTP (v2) Yes Yes Yes Yes Yes
Copy from SFTP (v2) Yes Yes Yes Yes Yes
Copy a File Between Instances (v1) Yes Yes Yes Yes Yes
Copy a File Between Instances (v2) Yes Yes Yes Yes Yes
Clone an Environment (v1) Yes Yes Yes Yes Yes
Provide Feedback (v2) Yes Yes Yes Yes Yes
Send Email (v1) Yes Yes Yes Yes Yes
Send Email (v2) Yes Yes Yes Yes Yes
Set Email Domain Allowlist (v2) Yes Yes Yes Yes Yes
Get Email Domain Allowlist (v2) Yes Yes Yes Yes Yes
Skip Updates (v1) Yes Yes Yes Yes Yes
Skip Updates (v2) Yes Yes Yes Yes Yes
List Backups (v2) Yes Yes Yes Yes Yes
Restore Backups (v2) Yes Yes Yes Yes Yes
Restore Environment (v1) Yes Yes Yes Yes Yes
Infrastructure APIs: Manage Services
Get Information About All Services Yes Yes Yes Yes Yes
Get Idle Session Timeout (v2) Yes Yes Yes Yes Yes
Set Idle Session Timeout (v2) Yes Yes Yes Yes Yes
Restart the Service Instance (v1) Yes Yes Yes Yes Yes
Restart the Service Instance (v2) Yes Yes Yes Yes Yes
Run Recreate on a Service (v2) Yes Yes Yes Yes Yes
Infrsastructure APIs: Manage Application Snapshots
Get Information About a Specific Application Snapshot Yes Yes Yes Yes Yes
Get Information About All Application Snapshots Yes Yes Yes Yes Yes
Upload Application Snapshot (v1) Yes Yes Yes Yes Yes
Upload Application Snapshot (v2) Yes Yes Yes Yes Yes
Download Application Snapshot (v1) Yes Yes Yes Yes Yes
Download Application Snapshot (v2) Yes Yes Yes Yes Yes
Copy Application Snapshot (v1) Yes Yes Yes Yes Yes
Copy Application Snapshot (v2) Yes Yes Yes Yes Yes
Rename Application Snapshot (v1) Yes Yes Yes Yes Yes
Rename Application Snapshot (v2) Yes Yes Yes Yes Yes
Infrsastructure APIs: Manage Artifacts, Snapshots, and Migration Status
Export Categories Artifacts (v2) Yes Yes Yes Yes Yes
Get Categories (v2) Yes Yes Yes Yes Yes
Get Migration Status (v2) Yes Yes Yes Yes Yes
Get Snapshot Modification History (v2) Yes Yes Yes Yes Yes
Import Snapshot Artifacts (v2) Yes Yes Yes Yes Yes
List the Artifacts in a Category (v2) Yes Yes Yes Yes Yes
List Updated Artifacts (v2) Yes Yes Yes Yes Yes
List Snapshot Details (v2) Yes Yes Yes Yes Yes
List the Artifacts in a Snapshot (v2) Yes Yes Yes Yes Yes
List Import Options (v2) Yes Yes Yes Yes Yes
Repeat Export Snapshot (v2) Yes Yes Yes Yes Yes
Set Import Options (v2) Yes Yes Yes Yes Yes
Infrastructure APIs: First Generation APIs
LCM Import Yes Yes Yes Yes Yes
LCM Export Yes Yes Yes Yes Yes
List Files Yes Yes Yes Yes Yes
Delete Files Yes Yes Yes Yes Yes
Run Recreate on a Service Yes Yes Yes Yes Yes
Provide Feedback Yes Yes Yes Yes Yes
Infrastructure APIs: Security and Access Control
Get Restricted Data Access (v2) Yes Yes Yes Yes Yes
Set Restricted Data Access (v2) Yes Yes Yes Yes Yes
Get Virus Scan on File Upload (v2) Yes Yes Yes Yes Yes
Set Virus Scan on File Upload (v2) Yes Yes Yes Yes Yes
Manage Permission for Manual Access to Database (v1) Yes Yes Yes Yes Yes
Manage Permission for Manual Access to Database (v2) Yes Yes Yes Yes Yes
Set Encryption Key (v1) Yes Yes Yes Yes Yes
Set Encryption Key (v2) Yes Yes Yes Yes Yes
Support for IAM REST APIs Yes Yes Yes Yes Yes
Infrastructure APIs: Maintenance Operations
Get the Build Version and Daily Maintenance Time (v1) Yes Yes Yes Yes Yes
Get the Build Version and Daily Maintenance Window Time (v2) Yes Yes Yes Yes Yes
Set the Daily Maintenance Time (v1) Yes Yes Yes Yes Yes
Set the Daily Maintenance Time (v2) Yes Yes Yes Yes Yes
Run Daily Maintenance While Skipping the Scheduled Daily Maintenance (v1) Yes Yes Yes Yes Yes
Run Daily Maintenance While Skipping the Scheduled Daily Maintenance (v2) Yes Yes Yes Yes Yes
Infrastructure APIs: Usage Simulation
Simulate Concurrent Usage (v1) Yes Yes Yes Yes Yes
Planning
Add Member Yes Yes Yes Yes Yes
Change Planning Unit Status Yes Yes Yes    
Clear Data Slice Yes Yes Yes Yes Yes
Create or Update All Substitution Variables Defined for the Application Yes Yes Yes Yes  
Create User Variables Yes Yes Yes   Yes
Delete a Substitution Variable at the Plan Type Level Yes Yes Yes Yes  
Delete a Substitution Variable for the Application Yes Yes Yes Yes  
Delete a User Variable Yes Yes Yes   Yes
Delete Substitution Variables at the Plan Type Level Yes Yes Yes    
Delete Substitution Variables for the Application Yes Yes Yes    
Delete User Variable Definitions Yes Yes Yes   Yes
Execute a Job Yes Yes Yes Yes Yes
Export Data Slice Yes Yes Yes Yes  
Get a Derived Substitution Variable Defined at the Plan Type Level Yes Yes Yes Yes  
Get a Planning Unit Owner Photo Yes Yes Yes    
Get a Substitution Variable Defined for the Application Yes Yes Yes Yes  
Get All Substitution Variables Defined for the Application Yes Yes Yes Yes Yes
Get All User Variables Yes Yes Yes   Yes
Get Applications Yes Yes Yes Yes Yes
Get Application Summary Yes Yes Yes Yes Yes
Get Available Planning Unit Actions Yes Yes Yes    
Get Derived Substitution Variables at the Plan Type Level Yes Yes Yes Yes  
Get Dimensions for a Plan Type Yes Yes Yes    
Get Dimension Details Yes Yes Yes    
Get Filters with All Possible Values Yes Yes Yes Yes  
Get Information about a Specific REST API Version for Planning Yes Yes Yes Yes Yes
Get Job Definitions Yes Yes Yes Yes Yes
Get Member Yes Yes Yes Yes Yes
Get Planning Unit History and Annotations Yes Yes Yes    
Get Planning Unit Promotional Path Yes Yes Yes    
Get Plan Types Yes Yes Yes    
Get Substitution Variables Defined at the Plan Type Level Yes Yes Yes Yes  
Get User Preferences Yes Yes Yes Yes Yes
Get User Variable Values Defined for the Application Yes Yes Yes Yes Yes
Get User Variable Values Defined for the Application by the User Name Yes Yes Yes Yes Yes
Get User Variable Values Defined in the Application by the User Name and Value Yes Yes Yes Yes Yes
Get User Variable Values Defined in the Application by the User Variable Name Yes Yes Yes Yes Yes
Get User Variable Values Defined in the Application by Value Yes Yes Yes Yes Yes
Get a User Variable Using Its ID Yes Yes Yes   Yes
Getting API Versions for Planning Yes Yes Yes Yes Yes
Import Data Slice Yes Yes Yes Yes Yes
List Library Documents Yes Yes Yes Yes Yes
List All Planning Units Yes Yes Yes    
Retrieve Child Job Status Details Yes Yes Yes Yes Yes
Retrieve Job Status Yes Yes Yes Yes Yes
Retrieve Job Status Details Yes Yes Yes Yes Yes
Set the User Variable Values for the Application Yes Yes Yes Yes Yes
Update User Variables Yes Yes Yes   Yes
Financial Consolidation and Close
Clear Data     Yes    
Copy Data     Yes    
Export Configurable Consolidation Rulesets     Yes    
Export Consolidation Journals     Yes    
Generate an Intercompany Matching Report     Yes    
Generate Report for Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management and Planning     Yes    
Generate User Details Report for Financial Consolidation and Close and Tax Reporting     Yes    
Getting API Versions for Financial Consolidation and Close APIs     Yes    
Get Information about a Specific API Version for Financial Consolidation and Close APIs     Yes    
Import Configurable Consolidation Rulesets     Yes    
Import Consolidation Journals     Yes    
Perform Journal Actions for Financial Consolidation and Close     Yes    
Perform Journal Period Updates for Financial Consolidation and Close     Yes    
Retrieve Job Status for a Report     Yes    
Retrieve Journals for Financial Consolidation and Close     Yes    
Retrieve Journal Details for Financial Consolidation and Close     Yes    
Validate Metadata     Yes    
Enterprise Profitability and Cost Management
Calculate Model (v3)       Yes  
Clear Data By Point of View (v3)       Yes  
Copy Data by Point of View       Yes  
Delete Point of View       Yes  
Generate Model Documentation Report       Yes  
Validate Model       Yes  
Tax Reporting
Copy Data         Yes
Clear Data         Yes
Generate Report for Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management and Planning     Yes   Yes
Generate User Details Report for Financial Consolidation and Close and Tax Reporting         Yes
Getting API Versions for Tax Reporting APIs         Yes
Get Information about a Specific API Version for Tax Reporting     Yes   Yes
Retrieve Job Status for a Report     Yes   Yes