Table of Contents

• Title and Copyright Information
• Documentation Accessibility
• Documentation Feedback
• 1 Getting Started with EPM Cloud REST APIs
  • Cloud EPM REST APIs at a Glance
  • REST APIs and AI REST APIs overview for Enterprise Performance Management (EPM), Enterprise Data Management (EDM), and Narrative Reporting (NR)
  • Implementation Best Practices for Cloud EPM REST APIs
  • About the REST APIs for Cloud EPM
    • About REST APIs for Cloud EPM, EDM, and Narrative Reporting
  • Cloud EPM REST API Compatibility
  • About the Samples
  • Audience
  • Prerequisites
  • URL Structure
  • OAuth 2 and Basic Authentication for Cloud EPM REST APIs
    • Authentication with OAuth 2
    • Basic Authentication
  • REST Resources and Methods
    • Supported REST Methods
    • REST API Methods
    • Error Handling
    • Versioning
    • Current REST API Version
    • Status Codes
  • Quick Reference Table – REST API Resource View
  • 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
• 2 Infrastructure REST APIs
  • Managing Users, Groups, Roles, and Access Reports
    • 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 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
    • Update Users (v1)
    • Update Users (v2)
    • Add a User to a Batch of Groups
    • Remove a User from a Batch of Groups
    • Import User Group Assignments as CSV
    • Update Granular Roles For Groups
    • Update Granular Roles for Users
    • Add Groups (v1)
    • Add Groups (v2)
    • List Groups
    • Update Groups
    • 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
    • Role Assignment Report (v1)
    • Role Assignment Report for Users (v2)
    • Role Assignment Report for Groups (v2)
    • Get Available Roles
    • Role Assignment Audit Report
    • Invalid Login Report
    • 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
  • Environment Lifecycle and Migration
    • Migration REST APIs
      • URL Structure for Migration
      • Migration Status Codes
      • Get 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 (v2)
        • LCM Export (v2)
      • Upload and Download Files
        • Upload
        • Download
      • View and Delete Files
        • List Files (v2)
        • Delete Files (v2)
        • Delete Files (v3)
      • Copy to and from the Object Store
        • 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 and from SFTP
        • Copy to SFTP (v2)
        • Copy from SFTP (v2)
      • Copy a File Between Instances
        • Copy a File Between Instances (v1)
        • Copy a File Between Instances (v2)
      • Clone an Environment (v1)
      • Provide Feedback (v2)
      • Send Email
        • Send Email (v1)
        • Send Email (v2)
      • Skip Updates
        • Skip Updates (v1)
        • Skip Updates (v2)
      • List or Restore Backups
        • List Backups (v2)
        • Restore Backups (v2)
      • Restore Environment (v1)
    • Manage Services
      • Get Information About All Services
      • Get Idle Session Timeout (v2)
      • Set Idle Session Timeout (v2)
      • Restart the Service Instance
        • Restart the Service Instance (v1)
        • Restart the Service Instance (v2)
      • Run Recreate on a Service (v2)
    • Manage Application Snapshots
      • Get Information About a Specific Application Snapshot
      • Get Information About All Application Snapshots
      • Upload Application Snapshot
        • Upload Application Snapshot (v1)
        • Upload Application Snapshot (v2)
      • Download Application Snapshot
        • Download Application Snapshot (v1)
        • Download Application Snapshot (v2)
      • Copy Application Snapshot
        • Copy Application Snapshot (v1)
        • Copy Application Snapshot (v2)
      • Rename Application Snapshot
        • Rename Application Snapshot (v1)
        • Rename Application Snapshot (v2)
    • Manage Artifacts, Snapshots, and Migration Status
      • Get Categories
      • List the Artifacts in a Category
      • Export Categories Artifacts
      • List Updated Artifacts
      • List Snapshot Details
      • Get Snapshot Modification History
      • List the Artifacts in a Snapshot
      • List Import Options
      • Set Import Options
      • Get Migration Status
    • First Generation APIs
      • LCM Import
      • LCM Export
      • List Files
      • Delete Files
      • Run Recreate on a Service
      • Provide Feedback
  • Security and Access Control
    • URL Structure for Security
    • 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
  • Maintenance Operations
    • URL Structure for Daily Maintenance
    • 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)
    • Usage Simulation REST APIs
      • URL Structure for Usage Simulation
      • Simulate Concurrent Usage
• 3 Cloud EPM Platform
  • Data Integration and Data Management REST APIs
    • URL Structure for Data Integration and Data Management
    • Getting API Versions for Data Integration and Data Management APIs
      • Get API Versions for Data Integration and Data Management APIs
      • Get Information about a Specific API Version for Data Integration and Data Management APIs
    • Get Pipeline Details
    • Import Data Mapping
    • Import Data Integration
    • Export Data Mapping
    • Export Data Integration
    • Lock and Unlock POV
    • Run Integrations
    • Run a Pipeline
    • Run Data Rules in Data Management
    • Running Batch Rules in Data Management
    • Retrieve Job Status
    • Update Connection in Data Integration
  • Connection REST APIs
    • View a Connection
    • View All Connections
    • Update a Connection
  • Reporting REST APIs
    • 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
    • Retrieve Job Status for a Report
    • Execute Reports for Data Management
  • Essbase
    • Export Essbase Data (v2)
    • Essbase Block Analysis Report (v1)
    • Get Essbase Query Governor Execution Time (v2)
    • Set Essbase Query Governor Execution Time (v2)
• 4 Platform Extensions
  • 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
  • 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
    • Execute Supplemental Data Manager Job
  • 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
    • Manage Connections in Task Manager
      • Create a Connection
      • View All Connections
      • Update a Connection
      • Delete a Connection
• 5 Account Reconciliation REST 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
  • Archive Matched Transactions (Transaction Matching)
  • Change Period Status (Reconciliation Compliance)
  • Create Reconciliation (Reconciliation Compliance)
  • Delete Profile
  • Execute a Job in Account Reconciliation
  • Export Application Properties
  • Export Background Image
  • Export Logo Image
  • Generate Balance Summary Report for Account Reconciliation
  • Generate Balance Report Transactions for Account Reconciliation
  • Generate Cosmetic Changes Report for Account Reconciliation
  • Generate Report for Account Reconciliation
  • Generate User Details Report for Account Reconciliation
  • Import Application Properties
  • Import Attribute Values
  • Import Background Image
  • Import Balances (Reconciliation Compliance)
  • Import Logo Image
  • Import Pre-Mapped Balances (Reconciliation Compliance)
  • Import Pre-Mapped Transactions (Reconciliation Compliance)
  • Import Profiles (Reconciliation Compliance)
  • Import Rates (Reconciliation Compliance)
  • Import Pre-Mapped Transactions (Transaction Matching)
  • Import Reconciliation Attributes (Reconciliation Compliance)
  • Monitor Reconciliations (Reconciliation Compliance)
  • Predict Predicted Attribute (Reconciliation Compliance)
  • Purge Transactions (Transaction Matching)
  • Purge Archived Transactions (Transaction Matching)
  • Retrieve Periods with a Specific Status
  • Run Auto Match (Transaction Matching)
  • Retrieve Job Status (Reconciliation Compliance)
  • Retrieve Job Status (Transaction Matching)
  • Retrieve Application Access Level
  • Run Auto Alert (Transaction Matching)
  • Run Train Match Prediction (Transaction Matching)
  • Run Profile Rule
  • Run Reconciliation Rule
  • Set Application Access Level
  • Train Predicted Attribute (Reconciliation Compliance)
  • Unmatch Matched Transactions (Transaction Matching)
  • Unmatch Transactions Matched by Auto Match (Transaction Matching)
  • Update Unmatched Transactions (Transaction Matching)
  • View Reconciliation Comments
  • Manage Connections in Account Reconciliation
    • Create a Connection
    • Delete a Connection
    • View All Connections
    • Update a Connection
• 6 Enterprise Data Management REST APIs
• 7 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
  • Generate Model Documentation Report
  • Calculate Model (v3)
  • Clear Data By Point of View (v3)
  • Copy Data by Point of View
  • Delete Point of View
  • Using Substitution Variables in Enterprise Profitability and Cost Management REST APIs
  • Validate Model
• 8 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
  • Copy Data
  • Clear Data
  • Export Consolidation Journals
  • Export Configurable Consolidation Rulesets
  • Generate an Intercompany Matching Report
  • 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 Journals for Financial Consolidation and Close
  • Retrieve Journal Details for Financial Consolidation and Close
  • Validate Metadata
• 9 Narrative Reporting REST APIs
• 10 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
  • 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
  • Get Applications
  • Get Application Summary
  • Get Dimensions for a Plan Type
  • Get Dimension Details
  • Get Plan Types
  • Get User Preferences
  • Get and Set 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
  • Get and Set 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 Application by the User Name and Value
    • Set the User Variable Values for the Application
  • List Library Documents
  • Manage Jobs
    • Execute a Job
      • Administration Mode
      • Auto Predict
      • Compact Cube
      • Configure the Oracle Guided Learning (OGL) Server
      • Clear Cube
      • Cube Refresh
      • Delete Library Documents
      • Execute Job Code Samples
      • Export Audit
      • Export Cell-Level Security
      • Export Data
      • Export Job Console
      • Export Security
      • Execute a Report Bursting Definition
      • Export Library Documents
      • Export Metadata
      • Export User Variable Values
      • Export Valid Intersections
      • Import Cell-Level Security
      • Import Data
      • Import Exchange Rates
      • Import Library Documents
      • Import Metadata
      • Import Security
      • Import User Variable Values
      • Import Valid Intersections
      • Merge Data Slices
      • Optimize Aggregation
      • Plan Type Map
      • Restructure Cube
      • Rules
      • Ruleset
      • Sort Members
    • Get Job Definitions
    • Retrieve Job Status
    • Retrieve Job Status Details
    • Retrieve Child Job Status Details
  • Managing User Variables
    • Create User Variables
    • Delete a User Variable
    • Delete User Variable Definitions
    • Get All User Variables
    • Get a User Variable Using Its ID
    • Update User Variables
  • Manage Planning Units
    • Change Planning Unit Status
    • 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
    • List All Planning Units
  • Working with Data Slices
    • Clear Data Slices
    • Import Data Slices
    • Export Data Slices
    • Export Data
    • Export Form Data
  • Working with Members
    • Add Member
    • Get Member
• 11 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
• 12 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
• A 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
• B 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