Table of Contents

• Title and Copyright Information
• Documentation Accessibility
• Documentation Feedback
• 1 Getting Started with Cloud EPM REST APIs
  • About REST APIs for Cloud EPM, EDM, and Narrative Reporting
  • Prerequisites
  • Authentication for Cloud EPM REST APIs
    • Basic Authentication
    • Authentication with OAuth 2
  • REST API Fundamentals
    • About REST Resources
    • URL Structure
    • REST API Methods
    • Versioning
    • Error Handling and Status Codes
  • Cloud EPM REST APIs Best Practices
  • Cloud EPM REST APIs at a Glance
• 2 Infrastructure REST APIs
  • Identity and Access Management
    • List Users (v1)
    • Add Users to an Identity Domain
      • Add Users to an Identity Domain (v1)
      • Add Users to an Identity Domain (v2)
    • Remove Users from Identity Domains
      • Remove Users from an Identity Domain (v1)
      • Remove Users from an Identity Domain (v2)
    • List Groups (v1)
    • Add Groups
      • Add Groups (v1)
      • Add Groups (v2)
    • Remove Groups
      • Remove Groups (v1)
      • Remove Groups (v2)
    • Get Available Roles (v2)
    • Application Roles and Granular Roles
      • Assign Users to an Application Role or Granular Role (v1)
      • Assign Users to an Application Role or Granular Role (v2)
    • Remove Users from Application Roles or Granular Roles
      • Remove Users Role Assignment (v1)
      • Remove Users Role Assignment (v2)
    • Add Users to Groups
      • Add Users to a Group (v1)
      • Add Users to a Group (v2)
    • Remove Users from Groups
      • Remove Users from a Group (v1)
      • Remove Users from a Group (v2)
    • Update Users
      • Update Users (v1)
      • Update Users (v2)
    • Add a User to a Batch of Groups (v1)
    • Remove a User from a Batch of Groups (v1)
    • Import User Group Assignments as CSV (v1)
    • Update Granular Roles For Groups (v1)
    • Update Granular Roles for Users (v1)
    • Update Groups (v1)
  • Access Control and Identity Reports
    • User Group Reports
      • User Group Report (v1)
      • User Group Report (v2)
    • User Access Reports
      • User Access Report (v1)
      • User Access Report (v2)
    • User Audit Report (v1) (Deprecated)
    • User Audit Report (v2) (Deprecated)
    • User Login Report (v1)
    • Role Assignment Report (v1)
    • Role Assignment Report for Users (v2)
    • Role Assignment Report for Groups (v2)
    • Role Assignment Audit Report (v1)
    • Invalid Login Report (v1)
    • Group Assignment Audit Report (v2)
  • Migration and Application Snapshots
    • 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
    • List or Restore Backups
      • List Backups (v2)
      • Restore Backups (v2)
    • Get Information About All Application Snapshots
    • Import and Export Files
      • LCM Import (v2)
      • LCM Export (v2)
    • Rename Application Snapshot
      • Rename Application Snapshot (v1)
      • Rename Application Snapshot (v2)
    • Upload Application Snapshot
      • Upload Application Snapshot (v1)
      • Upload Application Snapshot (v2)
    • Download Application Snapshot
      • Download Application Snapshot (v1)
      • Download Application Snapshot (v2)
    • Get Information About a Specific Application Snapshot
    • Copy Application Snapshot
      • Copy Application Snapshot (v1)
      • Copy Application Snapshot (v2)
    • Get Categories (v2)
    • List the Artifacts in a Category (v2)
    • Export Categories Artifacts (v2)
    • List Updated Artifacts (v2)
    • List Snapshot Details (v2)
    • Import Snapshot Artifacts (v2)
    • List Import Options (v2)
    • Get Snapshot Modification History (v2)
    • List the Artifacts in a Snapshot (v2)
    • Set Import Options (v2)
    • Get Migration Status (v2)
    • Repeat Export Snapshot (v2)
  • Simulate Concurrent Usage
    • Simulate Concurrent Usage (v1)
  • Essbase Data Export
    • Export Essbase Data (v2)
  • Essbase Block Analysis
    • Essbase Block Analysis Report (v1)
  • Query Governor Settings
    • Get Essbase Query Governor Execution Time (v2)
    • Set Essbase Query Governor Execution Time (v2)
  • Files, Object Storage and SFTP
    • View and Delete Files
      • List Files (v2)
      • Delete Files (v2)
      • Delete Files (v3)
    • Delete Folder (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)
    • Upload and Download Files
      • Upload
      • Download
    • Copy a File Between Instances
      • Copy a File Between Instances (v1)
      • Copy a File Between Instances (v2)
    • Copy to and from SFTP
      • Copy to SFTP (v2)
      • Copy from SFTP (v2)
  • Environment, Services and Maintenance
    • Get Information About All Services
    • Restart the Service Instance
      • Restart the Service Instance (v1)
      • Restart the Service Instance (v2)
    • Run Recreate on a Service (v2)
    • 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)
    • Clone an Environment (v1)
    • Restore Environment (v1)
    • Provide Feedback (v2)
    • Send Email
      • Send Email (v1)
      • Send Email (v2)
    • Set Email Domain Allowlist (v2)
    • Get Email Domain Allowlist (v2)
    • Get Idle Session Timeout (v2)
    • Set Idle Session Timeout (v2)
    • Skip Updates
      • Skip Updates (v1)
      • Skip Updates (v2)
    • First Generation REST APIs
      • LCM Import
      • LCM Export
      • List Files
      • Delete Files
      • Run Recreate on a Service
      • Provide Feedback
  • Security Administration
    • 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)
• 3 Cloud EPM Platform REST APIs
  • Application Administration (Planning, FreeForm, FCCS, EPCMCS, TRCS)
    • Get Applications
    • Get Application Summary
    • Export Metadata
    • Import Metadata
    • Export Application Data
    • Import Data
    • Import Exchange Rates
    • Export Valid Intersections
    • Import Valid Intersections
    • List Library Documents
    • Export Library Documents
    • Import Library Documents
    • Delete Library Documents
    • Get User Preferences
    • Administration Mode
    • Configure the Oracle Guided Learning (OGL) Server
    • Execute a Report Bursting Definition
    • Export Audit
    • Export Security
    • Import Security
    • Export Cell-Level Security
    • Import Cell-Level Security
  • Essbase Cube Management (Planning, FreeForm, FCCS, EPCMCS, TRCS)
    • Clear Cube
    • Compact Cube
    • Optimize Aggregation
    • Plan Type Map
    • Restructure Cube
  • Data Slice Management (Planning, FreeForm, FCCS, EPCMCS, TRCS)
    • Clear Data Slices
    • Export Planning Data
    • Export Form Data
    • Export Data Slices
    • Import Data Slices
    • Merge Data Slices
  • Member Management (Planning, FreeForm, FCCS, EPCMCS, TRCS)
    • Add Member
    • Get Member
    • Sort Members
  • Plan Type Dimension Queries (Planning, FreeForm, FCCS, TRCS)
    • Get Dimensions for a Plan Type
    • Get Plan Types
    • Get Dimension Details
  • Intelligent Performance Management (Planning, FreeForm, FCCS, EPCMCS, TRCS)
    • Get Insights
    • Insights Summary
    • Auto Predict
  • Job Definition and Execution (Planning, FreeForm, FCCS, EPCMCS, TRCS)
    • Get Job Definitions
    • Execute a Job
      • Execute Application Diagnostics
    • Retrieve Job Status
    • Retrieve Job Status Details
    • Retrieve Child Job Status Details
    • Export Job Console
  • User Details Report and Report Job Status (FCCS, TRCS)
    • Generate User Details Report for Financial Consolidation and Close and Tax Reporting
    • Retrieve Job Status for a Report
    • Execute Reports for Data Management
  • Planning Unit Workflow, Filters & Ownership (Planning, FreeForm, FCCS, TRCS)
    • Change Planning Unit Status
    • Get Available Planning Unit Actions
    • Get Planning Unit Owner Photo
    • Get Planning Unit History and Annotations
    • Get Planning Unit Promotional Path
    • List All Planning Units
    • Get Filters with All Possible Values
  • Substitution Variable Management
    • Application Substitution Variable Management (Planning, FreeForm, FCCS, TRCS, EPCMCS)
      • Create or Update All Substitution Variables Defined for the Application
      • Delete a Substitution Variable at the Plan Type Level
      • Delete a Substitution Variable for the Application
      • Get a Derived Substitution Variable Defined at the Plan Type Level
      • Get a Substitution Variable Defined for the Application
      • Get Derived Substitution Variables at the Plan Type Level
      • Get Substitution Variables Defined at the Plan Type Level
      • Get a Substitution Variable Defined at the Plan Type Level
      • Create and Update Substitution Variables at the Plan Type Level
    • Plan Type Substitution Variable Management (Planning, FreeForm, FCCS, TRCS)
      • Delete Substitution Variables at the Plan Type Level
      • Delete Substitution Variables for the Application
    • Substitution Variable Inquiry (Planning, FreeForm, FCCS, EPCMCS, TRCS)
      • Get All Substitution Variables Defined for the Application
  • User Variable Management (Planning, FreeForm, FCCS, TRCS)
    • 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
    • User Variable Values and Queries (Planning, FreeForm, FCCS, EPCMCS, TRCS)
      • Set the User Variable Values for the Application
      • Get User Variable Values Defined for the Application
      • 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
      • Get User Variable Values Defined in the Application by the User Variable Name
      • Get User Variable Values Defined in the Application by Value
      • Export User Variable Values
      • Import User Variable Values
  • Business Rules & Rulesets (Planning, FreeForm, FCCS, EPCMCS, TRCS)
    • Rules
    • Ruleset
  • Data Integration and Data Management
    • 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
    • Run Batch Rules in Data Management
    • Retrieve Job Status
    • Update Connection in Data Integration
  • Task Manager REST APIs
    • URL Structure for Task Manager
    • Get API Versions for Task Manager APIs
    • Manage Connections in Task Manager
      • Create a Connection
      • View All Connections
      • Update a Connection
      • Delete a Connection
    • Deploy Task Manager Templates
    • Update Task Status for Event Monitoring
  • Supplemental Data Manager REST APIs
    • URL Structure for Supplemental Data Manager
    • Get API Versions for Supplemental Data Manager APIs
    • Deploy Form Templates
    • Import Supplemental Collection Data for Financial Consolidation and Close
    • Execute Supplemental Data Manager Job
  • Enterprise Journal REST APIs
    • Get 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
• 4 Account Reconciliation REST APIs
  • Get API Versions
    • Get API Versions for Account Reconciliation REST APIs
    • Get Information about a Specific API Version for Account Reconciliation REST APIs
  • Configuration, Connections and Reports
    • Add Users to a Team for Account Reconciliation
    • Remove Users from a Team for Account Reconciliation
    • Export Application Properties
    • Import Application Properties
    • Export Background Image
    • Import Background Image
    • Export Logo Image
    • Import Logo Image
    • Generate User Details Report for Account Reconciliation
    • Generate Balance Report Transactions for Account Reconciliation
    • Generate Balance Summary Report for Account Reconciliation
    • Generate Cosmetic Changes Report for Account Reconciliation
    • Retrieve Application Access Level
    • Set Application Access Level
    • View All Connections
    • Create a Connection
    • Update a Connection
    • Delete a Connection
    • Generate Report for Account Reconciliation
    • Execute an Account Reconciliation Job
  • Reconciliation Compliance
    • Retrieve Periods with a Specific Status
    • Change Period Status (Reconciliation Compliance)
    • Import Pre-Mapped Transactions (Reconciliation Compliance)
    • Import Profiles (Reconciliation Compliance)
    • Import Rates (Reconciliation Compliance)
    • Import Balances (Reconciliation Compliance)
    • Import Pre-Mapped Balances (Reconciliation Compliance)
    • Import Reconciliation Attributes (Reconciliation Compliance)
    • Import Attribute Values
    • Monitor Reconciliations (Reconciliation Compliance)
    • Train Predicted Attribute (Reconciliation Compliance)
    • Predict Predicted Attribute (Reconciliation Compliance)
    • Run Profile Rule
    • Run Reconciliation Rule
    • Create Reconciliation (Reconciliation Compliance)
    • Delete Profile
    • Retrieve Job Status (Reconciliation Compliance)
    • View Reconciliation Comments
  • Transaction Matching
    • Import Pre-Mapped Transactions (Transaction Matching)
    • Run Auto Alert (Transaction Matching)
    • Purge Transactions (Transaction Matching)
    • Purge Archived Transactions (Transaction Matching)
    • Unmatch Matched Transactions (Transaction Matching)
    • Unmatch Transactions Matched by Auto Match (Transaction Matching)
    • Run Auto Match (Transaction Matching)
    • Run Train Match Prediction (Transaction Matching)
    • Archive Matched Transactions (Transaction Matching)
    • Retrieve Job Status (Transaction Matching)
    • Update Unmatched Transactions (Transaction Matching)
• 5 Enterprise Profitability and Cost Management REST APIs
  • Get API Versions for Enterprise Profitability and Cost Management
  • Get Information About a Specific REST API Version for Enterprise Profitability and Cost Management
  • Using Substitution Variables in Enterprise Profitability and Cost Management REST APIs
  • Enterprise Profitability and Cost Management Model Operations
    • Calculate Model (v3)
    • Create Point of View
    • Clear Data By Point of View (v3)
    • Copy Data by Point of View (v3)
    • Delete Point of View (v3)
    • Generate Model Documentation Report (v3)
    • Validate Model (v3)
• 6 Financial Consolidation and Close REST APIs
  • Get API Versions for Financial Consolidation and Close APIs
    • Get Information about a Specific API Version for Financial Consolidation and Close APIs
  • Consolidation Operations
    • Clear Data
    • Copy Data
    • Generate an Intercompany Matching Report
    • Validate Metadata
    • Export Consolidation Journals
    • Import Consolidation Journals
    • Perform Journal Actions for Financial Consolidation and Close
    • Bulk Journal Action API Comparison
    • Perform Bulk Journal Actions for Financial Consolidation and Close
    • Perform Detailed Bulk Journal Actions for Financial Consolidation and Close
    • Perform Journal Period Updates for Financial Consolidation and Close
    • Retrieve Journals for Financial Consolidation and Close
    • Export Configurable Consolidation Rulesets
    • Import Configurable Consolidation Rulesets
    • Generate Report for Financial Consolidation and Close, Tax Reporting, Enterprise Profitability and Cost Management and Planning
  • Financial Consolidation and Close
    • Retrieve Journal Details for Financial Consolidation and Close
    • Add Users to a Team for Financial Consolidation and Close and Tax Reporting
    • Remove Users from a Team for Financial Consolidation and Close and Tax Reporting
• 7 Planning and FreeForm REST APIs
  • Getting API Versions for Planning
    • Get REST API Versions for Planning
    • Get Information about a Specific REST API Version for Planning
  • Resources and Available Actions
  • Planning & FreeForm: Essbase Cube Management
    • Cube Refresh
  • Planning & FreeForm: Connections
    • View All Connections
    • Update a Connection
    • View a Connection
• 8 Profitability and Cost Management REST APIs
  • Get API Versions for Profitability and Cost Management REST APIs
    • Get Information about a Specific API Version for Profitability and Cost Management
  • Run ML Calculations
  • 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
  • Run ML Clear POV
  • Run ML Rule Balancing
  • Update Dimensions As a Job
  • Retrieve Task Status for Profitability and Cost Management
• 9 Tax Reporting REST APIs
  • Get API Versions for Tax Reporting APIs
    • Get Information about a Specific API Version for Tax Reporting
  • Copy Data
  • Clear Data
  • Generate a Translation Report
• 10 Identity Domains REST APIs
• 11 Narrative Reporting REST APIs
• 12 Enterprise Data Management REST APIs