Table of Contents

• Title and Copyright Information
• Documentation Accessibility
• Documentation Feedback
• 1 About the REST APIs for EPM Cloud
  • About REST API for Oracle Enterprise Performance Management Cloud
  • About the REST APIs
  • EPM Cloud REST API Compatibility
  • About the Samples
  • Audience
  • Prerequisites
  • URL Structure
• 2 OAuth 2 and Basic Authentication for EPM Cloud REST APIs
  • Authentication with OAuth 2 - Only for OCI (Gen 2) Environments
  • Basic Authentication - for Classic and OCI (Gen 2) Environments
• 3 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 Service Integration
  • Scenario 9: Using Groovy Business Rules to Call REST APIs from Oracle and Other Companies
• 4 Quick Reference Table – REST API Resource View
• 5 REST Resources and Methods
  • Supported REST Methods
  • REST API Methods
  • Error Handling
  • Versioning
  • Current REST API Version
  • Status Codes
• 6 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 Job Code Samples
      • Execute a Report Bursting Definition
    • 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 for Planning
    • 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
  • Working with Connections
    • View a Connection
    • View All Connections
    • Update a Connection
• 7 Migration REST APIs
  • URL Structure for Migration
  • Getting API Versions for Migration APIs
    • Get REST API Versions for Migration
    • Get Information About a Specific REST API Version for Migration
  • Upload and Download Files
    • Upload
    • Download
  • View and Delete Files
    • List Files
    • Delete Files
  • Manage Services
    • Get Information About All Services
    • Run Recreate on a Service
    • Restart the Service Instance
  • Manage Application Snapshots
    • Get Information About All Application Snapshots
    • Get Information About a Specific Application Snapshot
      • Get Information about a Specific Application Snapshot Sample Code
  • Use the Application Snapshot Service
    • Upload Application Snapshot
    • Download Application Snapshot
    • Copy Application Snapshot
    • Rename Application Snapshot
  • List Backups - Only for OCI (Gen 2) Environments
  • Restore Backup - Only for OCI (Gen 2) Environments
  • Copy to and from the Object Store
    • Copy to Object Store
    • Copy from Object Store
  • Provide Feedback
  • LCM Export
  • LCM Import
  • Manage Permission for Manual Access to Database
  • Migration Status Codes
  • Copy a File Between Instances
  • Skip Updates
  • Send Email
  • Clone an Environment
• 8 Viewing and Setting the Daily Maintenance Window Time
  • Getting and Setting the Daily Maintenance Window Time
    • Get the Build Version and Daily Maintenance Window Time
    • Setting the Daily Maintenance Window Time
    • Running Daily Maintenance While Skipping the Scheduled Daily Maintenance
• 9 Managing Users
  • Manage Users
  • Add Users to an Identity Domain
  • Remove Users from an Identity Domain
  • Assign Users to a Predefined Role or Application Role
  • Remove Users' Role Assignment
  • Update Users
  • Add Users To a Group
  • Remove Users from a Group
  • Add a User To a Batch of Groups
  • Remove a User from a Batch of Groups
  • Add Groups
  • Remove Groups
  • User Group Report
  • User Access Report
  • User Audit Report
  • Role Assignment Report
  • Role Assignment Audit Report for OCI (Gen 2) Environments
  • Invalid Login Report for OCI (Gen 2) Environments
  • Set Encryption Key
  • 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
• 10 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
• 11 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
  • Lock and Unlock POV
  • Integration Job Type
  • Import Data Mapping
  • Running Batch Rules
  • Export Data Mapping
  • Export Data Management
  • Import Data Management
• 12 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
  • Change Period Status (Reconciliation Compliance)
  • Create Reconciliation (Reconciliation Compliance)
  • 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)
  • Monitor Reconciliations (Reconciliation Compliance)
  • Import Reconciliation Attributes (Reconciliation Compliance)
  • Run Auto Match (Transaction Matching)
  • Purge Transactions (Transaction Matching)
  • Retrieve Job Status for Account Reconciliation
  • Export Application Properties
  • Import Application Properties
  • Export Background Image
  • Import Background Image
  • Export Logo Image
  • Import Logo Image
• 13 Financial Consolidation and Close REST APIs
  • Getting API Versions for Financial Consolidation and Close APIs
    • Getting API Versions for Financial Consolidation and Close
    • Get Information about a Specific API Version for Financial Consolidation and Close APIs
  • Import Supplemental Collection Data for Financial Consolidation and Close
  • 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
  • Copy Data
  • Clear Data
  • Deploy Form Templates
  • Deploy Task Manager Templates
  • Update Task Status for Event Monitoring
  • 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
• 14 Profitability and Cost Management REST APIs
  • URL Structure for Profitability and Cost Management
  • Getting API Versions for Profitability and Cost Management REST APIs
    • Get API Versions for Profitability and Cost Management REST APIs
      • Java Sample – GetRestAPIVersionsInfo.java for Profitability and Cost Management
      • cURL Sample – GetRestAPIVersionInfo.sh for Profitability and Cost Management
      • Groovy Sample – GetRestAPIVersionsInfo.groovy for Profitability and Cost Management
    • Get Information about a Specific API Version for Profitability and Cost Management
      • Get Information about a Specific API Version for Profitability and Cost Management
  • Manage Services
  • Apply Data Grants
    • Java Sample – applyDataGrants.java for Profitability and Cost Management
    • cURL Sample – ApplyDataGrants.sh for Profitability and Cost Management
    • Groovy Sample – ApplyDataGrants.groovy for Profitability and Cost Management
  • Create File-Based Application
    • Java Sample – CreateFlatFileApplication.java for Profitability and Cost Management
    • cURL Sample – CreateFlatFileApplication.sh for Profitability and Cost Management
    • Groovy Sample – CreateFlatFileApplication.groovy for Profitability and Cost Management
  • Deploy ML Cube
    • Java Sample – DeployCube.java for Profitability and Cost Management
    • cURL Sample – DeployCube.sh for Profitability and Cost Management
    • Groovy Sample – DeployCube.groovy for Profitability and Cost Management
  • Copy ML POV Data
    • Java Sample – CopyPOV.java for Profitability and Cost Management
    • cURL Sample – CopyPOV.sh for Profitability and Cost Management
    • Java Sample – CopyPOV.java for Profitability and Cost Management
  • Enable File-Based Application
    • Java Sample – EnableApplication.java for Profitability and Cost Management
    • cURL Sample – EnableApplication.sh for Profitability and Cost Management
    • Groovy Sample – EnableApplication.groovy for Profitability and Cost Management
  • Essbase Data Load for Profitability and Cost Management
    • Java Sample – EssbaseDataLoad.java for Profitability and Cost Management
    • cURL Sample – EssbaseDataLoad.sh for Profitability and Cost Management
    • Groovy Sample – EssbaseDataLoad.groovy for Profitability and Cost Management
  • Export Template for Profitability and Cost Management
    • Java Sample – ExportTemplate.java for Profitability and Cost Management
    • cURL Sample – ExportTemplate.sh for Profitability and Cost Management
    • Groovy Sample – ExportTemplate.groovy for Profitability and Cost Management
  • Export Query Results
    • Java Sample – ExportQueryResult.java for Profitability and Cost Management
    • cURL Sample – ExportQueryResult.sh for Profitability and Cost Management
    • Groovy Sample – ExportQueryResult.groovy for Profitability and Cost Management
  • Generate Program Documentation Report
    • Java Sample – GeneratePrgrmDocReport.java for Profitability and Cost Management
    • cURL Sample – GeneratePrgDocReport.sh for Profitability and Cost Management
    • Groovy Sample – GeneratePrgrmDocReport.groovy for Profitability and Cost Management
  • Generate Program Documentation Report - Run as a Job
    • Java Sample – GeneratePrgrmDocReport.java for Profitability and Cost Management
    • cURL Sample – GeneratePrgDocReport.sh for Profitability and Cost Management
    • Groovy Sample – GeneratePrgrmDocReport.groovy for Profitability and Cost Management
  • Import Template for Profitability and Cost Management
    • Java Sample – ImportTemplate.java for Profitability and Cost Management
    • cURL Sample – ImportTemplate.sh for Profitability and Cost Management
    • Groovy Sample – ImportTemplate.groovy for Profitability and Cost Management
  • Merge Slices for Profitability and Cost Management
  • Optimize ASO Cube
    • Java Sample – OptimizeASOCube.java for Profitability and Cost Management
    • cURL Sample – OptimizeASOCube.sh for Profitability and Cost Management
    • Groovy Sample – OptimizeASOCube.groovy for Profitability and Cost Management
  • Retrieve Task Status for Profitability and Cost Management
  • Run ML Calculations
    • Java Sample – RunCalculation.java for Profitability and Cost Management
    • cURL Sample – RunCalculation.sh for Profitability and Cost Management
    • Groovy Sample – RunCalculation.groovy for Profitability and Cost Management
  • Run ML Clear POV
    • cURL Sample – ClearPOV.sh for Profitability and Cost Management
    • Groovy Sample – ClearPOV.groovy for Profitability and Cost Management
    • Java Sample – clearPOV.java for Profitability and Cost Management
  • Run ML Rule Balancing
    • Java Sample – RunRuleBalancing.java for Profitability and Cost Management
    • cURL Sample – RunRuleBalancing.sh for Profitability and Cost Management
    • Groovy Sample – RunRuleBalancing.groovy for Profitability and Cost Management
  • Update File-Based Application
    • Java Sample – UpdateDimension.java for Profitability and Cost Management
    • cURL Sample – UpdateDimension.sh for Profitability and Cost Management
    • Groovy Sample – UpdateDimension.groovy for Profitability and Cost Management
  • Update Dimensions As a Job
    • Java Sample – UpdateDimensionJob.java for Profitability and Cost Management
    • cURL Sample – UpdateDimensionJob.sh for Profitability and Cost Management
    • Groovy Sample – UpdateDimensionJob.groovy for Profitability and Cost Management
• 15 Narrative Reporting REST APIs
• 16 Enterprise Data Management Cloud 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