Diagnosing REST API Issues

Applies to

Oracle Hyperion Planning, Planning Modules, FreeForm, Financial Consolidation and Close, Tax Reporting, Account Reconciliation, Oracle Hyperion Profitability and Cost Management, Enterprise Profitability and Cost Management, Oracle Enterprise Data Management Cloud, Narrative Reporting, Sales Planning, and Strategic Workforce Planning.

Finding Your Identity Domain

Ensure that you are correctly specifying your identity domain when executing REST APIs.

Use one of the following methods to identify your identity domain:

Look in the Activity Report for your environment. The name of the identity domain is displayed at the top left corner of the Activity Report. See About the Activity Report in Oracle Enterprise Performance Management Cloud Getting Started with Oracle Enterprise Performance Management Cloud for Administrators.
Derive the identity domain from the URL that you use to access the environment. For example, in the URL https://epm-exampleDomain.epm.dataCenter.oraclecloud.com/epmcloud, the identity domain name is exampleDomain.

Resolving Script Execution Failures After Changing the EPM Cloud Password

You will receive periodic password expiry warnings from oraclecloudadmin_ww@oracle.com. after changing your password, scripts that use your old EPM Cloud credentials will fail to run.

If you use an encrypted password file to run scripts, update your password encryption file using the encrypt EPM Automate command to reflect the new password. If you use plain text passwords in scripts, be sure to update them.

Resolving Session Failures in SSO-Enabled Classic Environments

In Classic environments, you must always use your identity domain credentials to run REST APIs. If your service is configured for SSO with an identity provider, you cannot execute REST APIs using your SSO (identity provider) credentials that you use to access EPM Cloud.

If the service is configured for SSO, an Identity Domain Administrator must enable all users who run REST APIs to sign in with their identity domain credentials.

See these information sources:

Ensuring that Users Can Run EPM Cloud Utilities After Configuring SSO in Oracle Enterprise Performance Management Cloud Getting Started with Oracle Enterprise Performance Management Cloud for Administrators
Enabling Sign In With Identity Domain Credentials in Administering Oracle Cloud Identity Management

Checking Your Credentials

If you cannot sign in to your environment using REST API, use the credentials you are using with REST API to sign into the environment using a browser or EPM Automate. If your sign in attempt fails, see Resolving Login Issues.

Resolving Copy Application Snapshot API Failures in IP Allowlist-Enabled Environments

If the current environment has IP allowlist configured, you may get an error while issuing Copy Application Snapshot API. To fix it, see Outbound IP Addresses of EPM Cloud Data Centers and Regions to identify the outbound IP address of the source environment that you specified in the Copy Application Snapshot API parameter and add it to the allowlist of the current environment.

Seeking Help

If you can sign in using a browser or EPM Automate, but not through REST APIs or if you can sign in using REST API but an error is reported in using an API, contact Oracle Support for help.

Create a Provide Feedback submission. Optionally, allow Oracle to access the maintenance snapshot of the environment by consenting to application snapshot submission. See Creating a Provide Feedback Submission.
Create a technical service request that identifies the Provide Feedback reference number. See Submitting a Technical Service Request. The service request must contain the following additional information:
- The REST API URL, user name, payload, query parameters, and headers.
- Error messages that you received.
- Did this issue start after the latest monthly update?
- Is this is a critical outage?