Table of Contents
- Title and Copyright Information
- Documentation Accessibility
- Documentation Feedback
- 1 About the REST APIs for EPM Cloud
-
2
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
- 3 Quick Reference Table – REST API Resource View
- 4 REST Resources and Methods
-
5
Planning REST APIs
- URL Structure for Planning
- Resources and Available Actions
- Getting REST API Versions 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
- Execute Job Code Samples
- Retrieve Job Status
- Retrieve Job Status Details
- Retrieve Child Job Status Details
- Working with Members
- Get Applications
- Manage Planning Units
- Get User Preferences
- Working with 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
-
6
Migration REST APIs
- URL Structure for Migration
- Getting API Versions for Migration APIs
- Upload and Download Files
- View and Delete Files
- Manage Services
- Manage Application Snapshots
- Use the Application Snapshot Service
- Copy to and from the 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
- 7 Viewing and Setting the Daily Maintenance Window Time
-
8
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
- 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
- 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
- 9 Reporting REST APIs
- 10 Data Management REST APIs
-
11
Account Reconciliation APIs
- URL Structure for Account Reconciliation
- Getting API Versions 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)
- Run Auto Match (Transaction Matching)
- Retrieve Job Status for Account Reconciliation
-
12
Financial Consolidation and Close REST APIs
- Getting API Versions 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
-
13
Profitability and Cost Management REST APIs
- URL Structure for Profitability and Cost Management
- Getting API Versions for Profitability and Cost Management REST APIs
- Apply Data Grants
- Generate Program Documentation Report
- Generate Program Documentation Report - Run as a Job
- Retrieve Task Status for Profitability and Cost Management
- Deploy ML Cube
- Merge Slices for Profitability and Cost Management
- Run ML Calculations
- Run ML Clear POV
- Copy ML POV Data
- Run ML Rule Balancing
- Essbase Data Load for Profitability and Cost Management
- Create File-Based Application
- Update File-Based Application
- Update Dimensions As a Job
- Enable File-Based Application
- Export Template for Profitability and Cost Management
- Import Template for Profitability and Cost Management
- Export Query Results
- 14 Narrative Reporting REST APIs
- 15 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
- G Profitability and Cost Management Common Helper Functions
- H Sample Starter Kit for Consultants - Integration with Business Intelligence Cloud Service