Versioning

Cloud EPM REST APIs are versioned at the API level. Every REST API request must include the supported API version as part of the request URL. If the API version is omitted or the specified version is not supported, the request fails.

For each service's API, you can get version and details for a specific REST API version. For details, see the service's API topics or Getting the Current REST API Version.

The API version is specified in the URL, as shown in the following examples:

https://<BASE-URL>/HyperionPlanning/rest/{api_version}/applications/{applicationName}/jobs
https://<BASE-URL>/interop/rest/{api_version}/applicationsnapshots

where {api_version} is the current REST API version for the product, for example, v3 for Planning.

Note:

API version identifiers are case-sensitive. For example, if the API version is v1, specifying V1 results in an error. Always use the correct case when specifying the API version.

Getting the Current REST API Version

Each Oracle Fusion Cloud Enterprise Performance Management business process provides a REST API for retrieving the supported API versions and version details. Use the appropriate topic for your business process: