Prerequisites

Before using the Oracle Fusion Cloud EPM REST APIs, review the following requirements and recommendations:

Intended Audience

This guide is intended primarily for infrastructure consultants and service administrators of Cloud EPM.

Infrastructure consultants can use this guide to build custom integrations and services for Cloud EPM business processes, including Planning, Planning Modules, Account Reconciliation, Financial Consolidation and Close, Enterprise Profitability and Cost Management, Profitability and Cost Management, Tax Reporting.

Service administrators can use this documentation to perform selected administrative tasks using REST APIs. Completing administrative tasks using EPM REST APIs as an alternative to using the user interface requires considerable technical and functional expertise. Only technically competent administrators should use this guide to perform these administrative tasks.

Requirements

Before using the REST APIs, ensure that you have:

  • An understanding of REST resources and Cloud EPM REST API concepts. For implementation recommendations, see Cloud EPM REST APIs Best Practices.

  • Access to the Cloud EPM with the required user roles and service configuration. For more information, see Getting Started for Administrators and Getting Started for Users.

  • Technical and functional knowledge to understand and execute the EPM REST APIs, and to administer the product.

  • Working knowledge of cURL and REST programming.

Depending on the operation you perform, the following product-specific prerequisites may also apply:

  • Jobs: Many REST APIs execute jobs such as importing and exporting data. Ensure that you familiarize yourself with managing jobs before using these APIs. For more information, see Managing Jobs.

  • Data Load Rules: Data load rules define how Data Management loads data from a file. You must have predefined data load rules to load data using REST APIs. You can also load data using batches defined in Data Management. Using a batch, Service Administrators can combine many load rules in a batch and execute them in serial or parallel mode.

  • Business Rules: Some REST APIs require business rules. For example, in Planning, business rules are created by using Calculation Manager and deployed to Planning applications. For more information, see Designing with Calculation Manager.

Using the Samples

This guide includes sample requests and responses for selected integration scenarios and REST API reference topics.

The examples assume that you have a working knowledge of REST programming concepts and cURL. This guide explains how to use Cloud EPM REST APIs; it does not provide an introduction to REST programming.

Copying Code Samples

Do not copy code samples from the PDF version of this guide. Line wrapping and footer text in the PDF can render code unusable. Oracle recommends copying code samples from the HTML version of this guide.