REST API for Oracle Enterprise Performance Management Cloud

386 Pages·2016·1.34 MB·English

Oracle® Cloud
REST API for Oracle Enterprise Performance
Management Cloud
E71243-19
Oracle Cloud REST API for Oracle Enterprise Performance Management Cloud,
E71243-19
Copyright © 2017, 2018, Oracle and/or its affiliates. All rights reserved.
Primary Author: EPM Information Development Team
This software and related documentation are provided under a license agreement containing restrictions on
use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your
license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify,
license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means.
Reverse engineering, disassembly, or decompilation of this software, unless required by law for
interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be error-free. If
you find any errors, please report them to us in writing.
If this is software or related documentation that is delivered to the U.S. Government or anyone licensing it on
behalf of the U.S. Government, then the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software,
any programs installed on the hardware, and/or documentation, delivered to U.S. Government end users are
"commercial computer software" pursuant to the applicable Federal Acquisition Regulation and agency-
specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the
programs, including any operating system, integrated software, any programs installed on the hardware,
and/or documentation, shall be subject to license terms and license restrictions applicable to the programs.
No other rights are granted to the U.S. Government.
This software or hardware is developed for general use in a variety of information management applications.
It is not developed or intended for use in any inherently dangerous applications, including applications that
may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you
shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its
safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this
software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of
their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are
used under license and are trademarks or registered trademarks of SPARC International, Inc. AMD, Opteron,
the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro
Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information about content, products,
and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly
disclaim all warranties of any kind with respect to third-party content, products, and services unless otherwise
set forth in an applicable agreement between you and Oracle. Oracle Corporation and its affiliates will not be
responsible for any loss, costs, or damages incurred due to your access to or use of third-party content,
products, or services, except as set forth in an applicable agreement between you and Oracle.
Contents
Documentation Accessibility
Documentation Feedback
1 About the REST APIs for EPM Cloud
About REST API for Oracle Enterprise Performance Management Cloud 1-1
About the REST APIs 1-1
EPM Cloud REST API Compatibility 1-2
About the EPM Automate Utility 1-5
About the Samples 1-6
Audience 1-6
Prerequisites 1-7
Authentication 1-7
URL Structure 1-7
2 Sample Integration Scenarios
Scenario 1: Import Metadata into Applications 2-1
Scenario 2: Import Data, Run a Calculation Script, and Copy Data from a Block
Storage Database to an Aggregate Storage Database 2-3
Scenario 3: Export and Download Metadata and Data 2-4
Scenario 4: Remove Unnecessary Files from a Service Instance 2-5
Scenario 5: Archive Backups from the Service to Onpremise 2-6
Scenario 6: Refreshing the Application 2-8
Scenario 7: Cloning an Instance 2-9
Scenario 8: Sample Starter Kit for Consultants - Business Intelligence Cloud Service
Integration 2-11
3 Quick Reference Table – REST API Resource View
iii
4 REST Resources and Methods
Supported REST Methods 4-1
REST API Methods 4-2
Error Handling 4-2
Versioning 4-2
Current REST API Version 4-2
Status Codes 4-3
5 Planning REST APIs
URL Structure for Planning 5-1
Resources and Available Actions 5-1
Getting REST API Versions for Planning 5-1
Get REST API Versions for Planning 5-2
Get Information about a Specific REST API Version for Planning 5-3
Manage Jobs 5-5
Get Job Definitions 5-5
Execute a Job 5-7
RULES 5-8
RULESET 5-9
PLAN_TYPE_MAP 5-10
IMPORT_DATA 5-11
EXPORT_DATA 5-11
IMPORT_METADATA 5-12
EXPORT_METADATA 5-13
CUBE_REFRESH 5-14
CLEAR_CUBE 5-15
Execute Job Code Samples 5-16
Retrieve Job Status 5-17
Retrieve Job Status Details 5-19
Retrieve Child Job Status Details 5-21
Working with Members 5-24
Add Member 5-24
Get Member 5-26
Get Applications 5-27
Manage Planning Units 5-28
List All Planning Units 5-29
Get Planning Unit History and Annotations 5-33
Get a Planning Unit Owner Photo 5-35
Get Planning Unit Promotional Path 5-36
Get Available Planning Unit Actions 5-38
iv
Get Filters with All Possible Values 5-40
Change Planning Unit Status 5-42
Get User Preferences 5-43
Working with Data Slices 5-44
Import Data Slices 5-45
Export Data Slices 5-49
Clear Data Slices 5-53
Getting and Setting Substitution Variables for Planning 5-56
Get All Substitution Variables Defined for the Application 5-57
Get a Substitution Variable Defined for the Application 5-58
Create or Update All Substitution Variables Defined for the Application 5-59
Get Substitution Variables Defined at the Plan Type Level 5-60
Get Derived Substitution Variables at the Plan Type Level 5-61
Get a Substitution Variable Defined at the Plan Type Level 5-63
Get a Derived Substitution Variable Defined at the Plan Type Level 5-64
Create and Update Substitution Variables at the Plan Type Level 5-65
6 Migration REST APIs
URL Structure for Migration 6-1
Getting API Versions for Migration APIs 6-1
Get REST API Versions for Migration 6-1
Get Information About a Specific REST API Version for Migration 6-4
Upload and Download Files 6-7
Upload 6-7
Download 6-14
View and Delete Files 6-18
List Files 6-19
Delete Files 6-21
Manage Services 6-24
Get Information About All Services 6-24
Run Recreate on a Service 6-27
Restart the Service Instance 6-29
Manage Application Snapshots 6-32
Get Information About All Application Snapshots 6-33
Get Information About a Specific Application Snapshot 6-34
Get Information about a Specific Application Snapshot Sample Code 6-36
Use the Application Snapshot Service 6-38
Upload Application Snapshot 6-38
Download Application Snapshot 6-40
Copy Application Snapshot 6-41
v
Provide Feedback 6-45
LCM Export 6-48
LCM Import 6-52
Migration Status Codes 6-57
7 Viewing User Reports and Viewing and Setting the Daily
Maintenance Window Time
User Provisioning Report 7-1
User Audit Report 7-4
Getting and Setting the Daily Maintenance Window Time 7-7
Get the Build Version and Daily Maintenance Window Time 7-7
Setting the Daily Maintenance Window Time 7-10
8 Data Management REST APIs
URL Structure for Data Management 8-1
Getting API Versions for Data Management APIs 8-1
Get API Versions for Data Management APIs 8-1
Get Information about a Specific API Version for Data Management APIs 8-3
Running Data Rules 8-4
Running Batch Rules 8-9
Import Data Mapping 8-11
Export Data Mapping 8-13
Execute Reports 8-15
9 Oracle Account Reconciliation Cloud APIs
URL Structure for Account Reconciliation 9-1
Getting API Versions for Account Reconciliation REST APIs 9-1
Get API Versions for Account Reconciliation REST APIs 9-1
Get Information about a Specific API Version for Account Reconciliation REST
APIs 9-3
Execute a Job in Account Reconciliation 9-4
Change Period Status (Reconciliation Compliance) 9-6
Create Reconciliation (Reconciliation Compliance) 9-7
Import Pre-Mapped Balances (Reconciliation Compliance) 9-9
Import Pre-Mapped Transactions (Reconciliation Compliance) 9-10
Import Balances (Reconciliation Compliance) 9-12
Import Profiles (Reconciliation Compliance) 9-13
Import Rates (Reconciliation Compliance) 9-15
Import Pre-Mapped Balances (Transaction Matching) 9-16
vi
Import Pre-Mapped Transactions (Transaction Matching) 9-18
Run Auto Match (Transaction Matching) 9-19
Retrieve Job Status for Account Reconciliation 9-20
10 Oracle Profitability and Cost Management Cloud REST APIs

URL Structure for Oracle Profitability and Cost Management Cloud 10-1
Getting API Versions for Oracle Profitability and Cost Management Cloud REST
APIs 10-1
Get API Versions for Oracle Profitability and Cost Management Cloud REST
APIs 10-2
Java Sample – GetRestAPIVersionsInfo.java for Oracle Profitability and
Cost Management Cloud 10-3
cURL Sample – GetRestAPIVersionInfo.sh for Oracle Profitability and Cost
Management Cloud 10-3
Groovy Sample – GetRestAPIVersionsInfo.groovy for Oracle Profitability
and Cost Management Cloud 10-4
Get Information about a Specific API Version for Oracle Profitability and Cost
Management Cloud 10-4
Get Information about a Specific API Version for Oracle Profitability and
Cost Management Cloud 10-6
Apply Data Grants 10-7
Java Sample – applyDataGrants.java for Oracle Profitability and Cost
Management Cloud 10-8
cURL Sample – ApplyDataGrants.sh for Oracle Profitability and Cost
Management Cloud 10-9
Groovy Sample – ApplyDataGrants.groovy for Oracle Profitability and Cost
Management Cloud 10-9
Generate Program Documentation Report 10-9
Retrieve Task Status for Oracle Profitability and Cost Management Cloud 10-11
Deploy ML Cube 10-12
Java Sample – DeployCube.java for Oracle Profitability and Cost Management
Cloud 10-14
cURL Sample – DeployCube.sh for Oracle Profitability and Cost Management
Cloud 10-14
Groovy Sample – DeployCube.groovy for Oracle Profitability and Cost
Management Cloud 10-15
Run ML Calculations 10-15
Java Sample – RunCalculation.java for Oracle Profitability and Cost
Management Cloud 10-18
cURL Sample – RunCalculation.sh for Oracle Profitability and Cost
Management Cloud 10-18
Groovy Sample – RunCalculation.groovy for Oracle Profitability and Cost
Management Cloud 10-19
Run ML Clear POV 10-20
vii
cURL Sample – ClearPOV.sh for Oracle Profitability and Cost Management
Cloud 10-22
Groovy Sample – ClearPOV.groovy for Oracle Profitability and Cost
Management Cloud 10-22
Java Sample – clearPOV.java for Oracle Profitability and Cost Management
Cloud 10-23
Copy ML POV Data 10-23
Java Sample – CopyPOV.java for Oracle Profitability and Cost Management
Cloud 10-25
cURL Sample – CopyPOV.sh for Oracle Profitability and Cost Management
Cloud 10-26
Java Sample – CopyPOV.java for Oracle Profitability and Cost Management
Cloud 10-26
Run ML Rule Balancing 10-27
Java Sample – RunRuleBalancing.java for Oracle Profitability and Cost
Management Cloud 10-29
cURL Sample – RunRuleBalancing.sh for Oracle Profitability and Cost
Management Cloud 10-29
Groovy Sample – RunRuleBalancing.groovy for Oracle Profitability and Cost
Management Cloud 10-30
Essbase Data Load for Oracle Profitability and Cost Management Cloud 10-31
Java Sample – EssbaseDataLoad.java for Oracle Profitability and Cost
Management Cloud 10-32
cURL Sample – EssbaseDataLoad.sh for Oracle Profitability and Cost
Management Cloud 10-33
Groovy Sample – EssbaseDataLoad.groovy for Oracle Profitability and Cost
Management Cloud 10-33
Create File-Based Application 10-34
Java Sample – CreateFlatFileApplication.java for Oracle Profitability and Cost
Management Cloud 10-35
cURL Sample – CreateFlatFileApplication.sh for Profitability and Cost
Management 10-36
Groovy Sample – CreateFlatFileApplication.groovy for Oracle Profitability and
Cost Management Cloud 10-36
Update File-Based Application 10-37
Java Sample – UpdateDimensions.java for Oracle Profitability and Cost
Management Cloud 10-38
cURL Sample – UpdateDimensions.sh for Oracle Profitability and Cost
Management Cloud 10-39
Groovy Sample – UpdateDimensions.groovy for Oracle Profitability and Cost
Management Cloud 10-39
Enable File-Based Application 10-40
Java Sample – EnableApplication.java for Oracle Profitability and Cost
Management Cloud 10-41
cURL Sample – EnableApplication.sh for Oracle Profitability and Cost
Management Cloud 10-42
viii
Groovy Sample – EnableApplication.groovy for Oracle Profitability and Cost
Management Cloud 10-42
Export Template for Oracle Profitability and Cost Management Cloud 10-42
Java Sample – ExportTemplate.java for Oracle Profitability and Cost
Management Cloud 10-44
cURL Sample – ExportTemplate.sh for Oracle Profitability and Cost
Management Cloud 10-44
Groovy Sample – ExportTemplate.groovy for Oracle Profitability and Cost
Management Cloud 10-45
Import Template for Oracle Profitability and Cost Management Cloud 10-45
Java Sample – ImportTemplate.java for Oracle Profitability and Cost
Management Cloud 10-47
cURL Sample – ImportTemplate.sh for Oracle Profitability and Cost
Management Cloud 10-48
Groovy Sample – ImportTemplate.groovy for Oracle Profitability and Cost
Management Cloud 10-48
Export Query Results 10-49
Java Sample – ExportQueryResult.java for Oracle Profitability and Cost
Management Cloud 10-51
cURL Sample – ExportQueryResult.sh for Oracle Profitability and Cost
Management Cloud 10-51
Groovy Sample – ExportQueryResult.groovy for Oracle Profitability and Cost
Management Cloud 10-52
A Common Helper Functions for Java
B Common Helper Functions for cURL
C Common Helper Functions for Groovy
D Sample Starter Kit for Consultants - Integration with Business
Intelligence Cloud Service
Installing the Scripting Engine and Deploying Demo Scripts D-2
SQL Application Express REST API client D-3
Business Intelligence REST API Client D-5
Oracle Planning and Budgeting Cloud REST API Client D-6
Helper Functions D-8
Integration of Oracle Planning and Budgeting Cloud to Business Intelligence Cloud
Service D-10
Groovy Sample – PBCSBICSIntegration.groovy D-10
ix
Groovy Sample – PbcsRestClient.groovy D-13
Groovy Sample – PbcsRestClient.groovy D-22
Groovy Sample – BicsRestClient.groovy D-32
Groovy Sample – ApexRestClient.groovy D-43
Troubleshooting the Integration D-51
E Oracle Profitability and Cost Management Cloud Common Helper
Functions
Oracle Profitability and Cost Management Cloud Common Helper Functions for
Java E-1
Oracle Profitability and Cost Management Cloud Common Helper Functions for
cURL E-7
Oracle Profitability and Cost Management Cloud Common Helper Functions for
Groovy E-14
x