URL Structure

This topic summarizes the URL structures to use for the REST APIs.

In the description and examples of all REST APIs, this guide uses:

Table 1-2 REST API URL Placeholders

Placeholder Description Example
<BASE-URL> The first part of your service URL, before the context. This placeholder is used throughout this guide in REST API descriptions and examples. If your service URL is https://epm-acme.epm.us-phoenix-1.ocs.oraclecloud.com/epmcloud, your <BASE-URL> is https://epm-acme.epm.us-phoenix-1.ocs.oraclecloud.com. Similarly, if your service URL is https://epm2-acme.epm.us6.oraclecloud.com/epmcloud, your <BASE-URL> is https://epm2-acme.epm.us6.oraclecloud.com.
api_version The version of the REST API v1, v2, v3
path Identifies the REST resource being accessed. applications, jobs, migration

Note:

Oracle Fusion Cloud Enterprise Performance Management does not authorize or support the use of any REST API endpoint not specified in this document. For example, <BASE-URL> such as https://epmacme.epm.us-phoenix-1.ocs.oraclecloud.com by itself will fail.

Similarly, Cloud EPM does not support the use of REST APIs with the path token "/internal/" in the URL.

Table 1-3 REST Endpoints - URL Structure

API Category Context path URL Pattern
Account Reconciliation armARCS
https://<BASE-URL>/armARCS/rest/{api_version}/{path}
https://<BASE-URL>/armARCS/rest/{api_version}/{path}
Data Integration and Data Management aif
https://<BASE-URL>/aif/rest/{api_version}/{path}
Enterprise Journal HyperionPlanning
https://<BASE-URL>/HyperionPlanning/rest/ej/{api_version}/{path}

Enterprise Profitability and Cost Management

Financial Consolidation and Close

Planning

Tax Reporting

HyperionPlanning
https://<BASE-URL>/HyperionPlanning/rest/{api_version}/{path}

Identity and Access Management

Access Control and Identity Reports

Migration and Application Snapshots

Simulate Concurrent Usage

Essbase Data Export

Essbase Block Analysis

Query Governor Settings

Files, Object Storage and SFTP

Environment, Services and Maintenance

Security Administration

interop
https://<BASE-URL>/interop/rest/{api_version}/{path}
Profitability and Cost Management epm
https://<BASE-URL>/epm/rest/{api_version}/{path}
Strategic Modeling HyperionPlanning
https://<BASE-URL>/HyperionPlanning/rest/sm/{api_version}/{path}
Supplemental Data Manager HyperionPlanning
https://<BASE-URL>/HyperionPlanning/rest/sdm/{api_version}/{path}