Table of Contents

• Title and Copyright Information
• Documentation Accessibility
• Documentation Feedback
• 1 Creating and Running an EPM Center of Excellence
• 2 Implementation Best Practices for Cloud EPM REST APIs
• 3 About the REST APIs for Cloud EPM
  • About REST APIs for Oracle Fusion Cloud EPM
  • Cloud EPM REST API Compatibility
  • About the Samples
  • Audience
  • Prerequisites
  • URL Structure
• 4 OAuth 2 and Basic Authentication for Cloud EPM REST APIs
  • Authentication with OAuth 2
  • Basic Authentication
• 5 Sample Integration Scenarios
  • Scenario 1: Import Metadata into Applications
  • Scenario 2: Import Data, Run a Calculation Script, and Copy Data from a Block Storage Database to an Aggregate Storage Database
  • Scenario 3: Export and Download Metadata and Data
  • Scenario 4: Remove Unnecessary Files from a Service Instance
  • Scenario 5: Archive Backups from the Service to Onpremise
  • Scenario 6: Refreshing the Application
  • Scenario 7: Cloning an Instance
  • Scenario 8: Sample Starter Kit for Consultants - Business Intelligence Cloud Integration
  • Scenario 9: Using Groovy Business Rules to Call REST APIs from Oracle and Other Companies
• 6 Quick Reference Table – REST API Resource View
• 7 REST Resources and Methods
  • Supported REST Methods
  • REST API Methods
  • Error Handling
  • Versioning
  • Current REST API Version
  • Status Codes
• 8 Planning REST APIs
  • URL Structure for Planning
  • Resources and Available Actions
  • Getting API Versions for Planning
    • Get REST API Versions for Planning
    • Get Information about a Specific REST API Version for Planning
  • Manage Jobs
    • Get Job Definitions
    • Execute a Job
      • Rules
      • Ruleset
      • Plan Type Map
      • Import Data
      • Export Data
      • Import Metadata
      • Export Metadata
      • Cube Refresh
      • Clear Cube
      • Administration Mode
      • Compact Cube
      • Restructure Cube
      • Merge Data Slices
      • Optimize Aggregation
      • Import Security
      • Export Security
      • Export Audit
      • Export Job Console
      • Sort Members
      • Import Exchange Rates
      • Auto Predict
      • Import Cell-Level Security
      • Export Cell-Level Security
      • Import Valid Intersections
      • Export Valid Intersections
      • Execute a Report Bursting Definition
      • Export Library Documents
      • Import Library Documents
      • Configure the Oracle Guided Learning (OGL) Server
      • Execute Job Code Samples
    • Retrieve Job Status
    • Retrieve Job Status Details
    • Retrieve Child Job Status Details
  • Working with Members
    • Add Member
    • Get Member
  • Get Applications
  • Manage Planning Units
    • List All Planning Units
    • 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
    • Change Planning Unit Status
  • Get User Preferences
  • Working with Data Slices
    • Import Data Slices
    • Export Data Slices
    • Clear Data Slices
  • Getting and Setting Substitution Variables
    • 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
  • Deleting Substitution Variables
    • Delete a Substitution Variable at the Plan Type Level
    • Delete a Substitution Variable for the Application
    • Delete Substitution Variables at the Plan Type Level
    • Delete Substitution Variables for the Application
  • Getting and Setting User Variable Values
    • 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 Appplication by the User Name and Value
    • Set the User Variable Values for the Application
  • Working with Connections
    • View a Connection
    • View All Connections
    • Update a Connection
• 9 Migration REST APIs
  • URL Structure for Migration
  • Migration Status Codes
  • Getting API Versions for Migration APIs
    • Get REST API Versions for Migration
    • Get Information About a Specific REST API Version for Migration
  • Import and Export Files
    • LCM Import (v1)
    • LCM Import (v2)
    • LCM Export (v1)
    • LCM Export (v2)
  • Upload and Download Files
    • Upload
    • Download
  • View and Delete Files
    • List Files (v11.1.2.3.600)
    • List Files (v2)
    • Delete Files (v11.1.2.3.600)
    • Delete Files (v2)
    • Delete Files (v3)
  • Manage Services
    • Get Information About All Services
    • Get Idle Session Timeout
    • Set Idle Session Timeout
    • Restart the Service Instance (v1)
    • Restart the Service Instance (v2)
    • Run Recreate on a Service (11.1.2.3.600)
    • Run Recreate on a Service (v2)
  • Manage Application Snapshots
    • Get Information About All Application Snapshots
    • Get Information About a Specific Application Snapshot
    • 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)
  • Copy to and from the Object Store
    • Copy from Object Store (v1)
    • Copy from Object Store (v2)
    • Copy to Object Store (v1)
    • Copy to Object Store (v2)
  • Copy to and from SFTP
    • Copy to SFTP
    • Copy from SFTP
  • Working with Essbase
    • Export Essbase Data (v2)
    • Essbase Block Analysis Report
    • Get Essbase Query Governor Execution Time
    • Set Essbase Query Governor Execution Time
  • Copy a File Between Instances (v1)
  • Copy a File Between Instances (v2)
  • Clone an Environment
  • Provide Feedback (v11.1.2.3.600)
  • Provide Feedback (v2)
  • Send Email (v1)
  • Send Email (v2)
  • Skip Updates (v1)
  • Skip Updates (v2)
  • List or Restore Backups - Only for OCI (Gen2) Environments
    • List Backups - Only for OCI (Gen 2) Environments
    • Restore Backup - Only for OCI (Gen 2) Environments
• 10 Security REST APIs
  • URL Structure for Security
  • Get Restricted Data Access
  • Set Restricted Data Access
  • Get Virus Scan on File Upload
  • Set Virus Scan on File Upload
  • Manage Permission for Manual Access to Database (v1)
  • Manage Permission for Manual Access to Database (v2)
  • Set Encryption Key (v1)
  • Set Encryption Key (v2)
  • View or Update the IP Allowlist - Only for OCI (Gen 2) Environments
    • View the IP Allowlist - Only for OCI (Gen 2) Environments
    • Update the IP Allowlist - Only for OCI (Gen 2) Environments
• 11 Viewing and Setting the Daily Maintenance Window Time
  • URL Structure for Daily Maintenance
  • Get the Build Version and Daily Maintenance Time (v1)
  • Get the Build Version and Daily Maintenance Window Time (v2)
  • Setting the Daily Maintenance Time (v1)
  • Setting the Daily Maintenance Time (v2)
  • Running Daily Maintenance While Skipping the Scheduled Daily Maintenance (v1)
  • Running Daily Maintenance While Skipping the Scheduled Daily Maintenance (v2)
• 12 Managing Users, Groups, and Roles
  • URL Structure for Users, Groups, and Roles
  • 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 a Predefined Role or Application Role (v1)
  • Assign Users to a Predefined Role or Application 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)
  • Update Users
  • Add a User to a Batch of Groups
  • Remove a User from a Batch of Groups
  • Add Groups (v1)
  • Add Groups (v2)
  • 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)
  • User Audit Report (v2)
  • Role Assignment Report (v1)
  • Role Assignment Report for Users (v2)
  • Role Assignment Report for Groups (v2)
  • Get Available Roles
  • Role Assignment Audit Report for OCI (Gen 2) Environments
  • Invalid Login Report for OCI (Gen 2) Environments
  • Group Assignment Audit Report
  • Adding Users to a Team for Account Reconciliation
  • Adding Users to a Team for Financial Consolidation and Close and Tax Reporting
  • Removing Users from a Team for Account Reconciliation
  • Removing Users from a Team for Financial Consolidation and Close and Tax Reporting
• 13 Usage Simulation REST APIs
  • URL Structure for Usage Simulation
  • Simulate Concurrent Usage
• 14 Reporting REST APIs
  • Generate Report for Account Reconciliation
  • Generate Report for Financial Consolidation and Close and Tax Reporting
  • Generate User Details Report for Account Reconciliation
  • Generate User Details Report for Financial Consolidation and Close and Tax Reporting
  • Retrieve Job Status for a Report
  • Execute Reports for Data Management
• 15 Data Integration REST APIs
  • URL Structure for Data Integration
  • Getting API Versions for Data Integration APIs
    • Get API Versions for Data Integration APIs
    • Get Information about a Specific API Version for Data Integration APIs
  • Lock and Unlock POV
  • Running Integrations
  • Running a Pipeline
  • Import Data Mapping
  • Export Data Mapping
  • Export Data Integration
  • Import Data Integration
  • Retrieve Job Status
• 16 Data Management REST APIs
  • URL Structure for Data Management
  • Getting API Versions for Data Management APIs
    • Get API Versions for Data Management APIs
    • Get Information about a Specific API Version for Data Management APIs
  • Running Data Rules in Data Management
  • Running Batch Rules
  • Retrieve Job Status
• 17 Account Reconciliation APIs
  • URL Structure for Account Reconciliation
  • Getting API Versions for Account Reconciliation REST APIs
    • Get API Versions for Account Reconciliation REST APIs
    • Get Information about a Specific API Version for Account Reconciliation REST APIs
  • Execute a Job in Account Reconciliation
  • Retrieve Periods with a Specific Status
  • Change Period Status (Reconciliation Compliance)
  • Create Reconciliation (Reconciliation Compliance)
  • Delete Profile
  • Import Pre-Mapped Balances (Reconciliation Compliance)
  • Import Pre-Mapped Transactions (Reconciliation Compliance)
  • Import Balances (Reconciliation Compliance)
  • Import Profiles (Reconciliation Compliance)
  • Import Rates (Reconciliation Compliance)
  • Import Pre-Mapped Transactions (Transaction Matching)
  • Import Attribute Values
  • Monitor Reconciliations (Reconciliation Compliance)
  • Import Reconciliation Attributes (Reconciliation Compliance)
  • Run Auto Match (Transaction Matching)
  • Purge Transactions (Transaction Matching)
  • Retrieve Job Status (Reconciliation Compliance)
  • Retrieve Job Status (Transaction Matching)
  • Export Application Properties
  • Import Application Properties
  • Export Background Image
  • Import Background Image
  • Export Logo Image
  • Import Logo Image
  • Working with Connections in Account Reconciliation
    • Create a Connection
    • View All Connections
    • Update a Connection
    • Delete a Connection
  • Set Application Access Level
  • Retrieve Application Access Level
  • View Reconciliation Comments
  • Archive Matched Transactions (Transaction Matching)
  • Purge Archived Transactions (Transaction Matching)
  • Unmatch Matched Transactions (Transaction Matching)
  • Unmatch Transactions Matched by Auto Match (Transaction Matching)
  • Update Unmatched Transactions (Transaction Matching)
• 18 Financial Consolidation and Close REST APIs
  • URL Structure for Financial Consolidation and Close
  • Getting API Versions for Financial Consolidation and Close APIs
    • Get Information about a Specific API Version for Financial Consolidation and Close APIs
  • Perform Journal Actions for Financial Consolidation and Close
  • Perform Journal Period Updates for Financial Consolidation and Close
  • Retrieve Journals for Financial Consolidation and Close
  • Retrieve Journal Details for Financial Consolidation and Close
  • Export Consolidation Journals
  • Import Consolidation Journals
  • Copy Data
  • Clear Data
  • Validate Metadata
  • Export Configurable Consolidation Rulesets
  • Import Configurable Consolidation Rulesets
  • Generate an Intercompany Matching Report
• 19 Task Manager REST APIs
  • URL Structure for Task Manager
  • Getting API Versions for Task Manager APIs
  • Deploy Task Manager Templates
  • Update Task Status for Event Monitoring
  • Working with Connections in Task Manager
    • Create a Connection
    • View All Connections
    • Update a Connection
    • Delete a Connection
• 20 Supplemental Data Manager REST APIs
  • URL Structure for Supplemental Data Manager
  • Getting API Versions for Supplemental Data Manager APIs
  • Import Supplemental Collection Data for Financial Consolidation and Close
  • Deploy Form Templates
• 21 Enterprise Journal REST APIs
  • URL Structure for Enterprise Journal REST APIs
  • Getting API Versions for Enterprise Journal APIs
  • Monitor Enterprise Journals for Financial Consolidation and Close
  • Execute an Enterprise Journals Job
  • Retrieve Enterprise Journals for Financial Consolidation and Close
  • Retrieve Enterprise Journal Content for Financial Consolidation and Close
  • Retrieve Enterprise Journal Content by Year and Period for Financial Consolidation and Close
  • Update Enterprise Journal Posting Status for Financial Consolidation and Close
  • Update Validation Status of Enterprise Journals for Financial Consolidation and Close
• 22 Tax Reporting REST APIs
  • URL Structure for Tax Reporting
  • Getting API Versions for Tax Reporting APIs
    • Get Information about a Specific API Version for Tax Reporting
  • Copy Data
  • Clear Data
• 23 Enterprise Profitability and Cost Management REST APIs
  • URL Structure for Enterprise Profitability and Cost Management
  • Getting API Versions for Enterprise Profitability and Cost Management
  • Getting Information About a Specific REST API Version for Enterprise Profitability and Cost Management
  • Calculate Model
  • Clear Data By Point of View
  • Copy Data by Point of View
  • Delete Point of View
  • Generate Model Documentation Report
  • Validate Model
• 24 Profitability and Cost Management REST APIs
  • URL Structure for Profitability and Cost Management
  • Get API Versions for Profitability and Cost Management REST APIs
  • Get Information about a Specific API Version for Profitability and Cost Management
  • Apply Data Grants
  • Copy ML POV Data
  • Create File-Based Application
  • Deploy ML Cube
  • Enable File-Based Application
  • Essbase Data Load for Profitability and Cost Management
  • Export Query Results
  • Export Template for Profitability and Cost Management
  • Generate Program Documentation Report
  • Generate Program Documentation Report - Run as a Job
  • Import Template for Profitability and Cost Management
  • Merge Slices for Profitability and Cost Management
  • Optimize ASO Cube
  • Retrieve Task Status for Profitability and Cost Management
  • Run ML Calculations
  • Run ML Clear POV
  • Run ML Rule Balancing
  • Update Dimensions As a Job
• 25 Narrative Reporting REST APIs
• 26 Enterprise Data Management Cloud REST APIs
• 27 Support for IAM REST APIs
• A Common Helper Functions for Java
• B CSS Common Helper Functions for Java
• C Common Helper Functions for cURL
• D CSS Common Helper Functions for cURL
• E CSS Common Helper Functions for Groovy
• F REST API Examples with Postman
  • Example: Using REST APIs to Upload with Postman
  • Example: Using REST APIs to Upload to an External Directory with Postman
  • Example: Using REST APIs to Upload a Snapshot with Postman
• G Profitability and Cost Management Common Helper Functions
  • Profitability and Cost Management Common Helper Functions for Java
  • Profitability and Cost Management Common Helper Functions for cURL
  • Profitability and Cost Management Common Helper Functions for Groovy
• H Sample Starter Kit for Consultants - Integration with Business Intelligence Cloud Service
  • Installing the Scripting Engine and Deploying Demo Scripts
  • SQL Application Express REST API client
  • Business Intelligence REST API Client
  • Planning REST API Client
  • Helper Functions
  • Integration of Planning to Business Intelligence Cloud Service
    • Groovy Sample – PBCSBICSIntegration.groovy
    • Groovy Sample – PbcsRestClient.groovy
    • Groovy Sample – PbcsRestClient.groovy
    • Groovy Sample – BicsRestClient.groovy
    • Groovy Sample – ApexRestClient.groovy
  • Troubleshooting the Integration