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