REST API Versions and URL Paths

A URL (Uniform Resource Locator) path identifies the REST resource that you want to call. A complete URL path consists of the server name and the resource path:

https://<server>/<resource-path>

The <server> is the REST API Server URL mentioned in the welcome email sent to your Oracle Cloud service administrator. For example:

https://servername.fa.us2.oraclecloud.com

The <resource-path> is the relative path or endpoint to the resource you're working with. For example, for workers, the resource path is as follows:

/hcmRestApi/resources/11.13.18.05/workers

So, the combined request URL for the workers resource becomes:

https://servername.fa.us2.oraclecloud.com/hcmRestApi/resources/11.13.18.05/workers

Note that the resource path typically contains the context root for the REST API web module and the API version of a resource. For example, for the workers resource, the context root for the REST API web module is hcmRestApi and the version is 11.13.18.05.

We recommend using the latest API version, 11.13.18.05. If a resource path doesn't contain a version number, then it results in a 404 error. Therefore, make sure to include the API version 11.13.18.05 in the resource path.

Note:

URLs need to be compliant with the ASCII character set. If URLs contain non-ASCII characters, they're automatically converted into a format that's compatible with HTTP. For more information about HTML URL encoding, refer to the article HTML Uniform Resource Locators on www.w3schools.com.

From Release 13 onwards, the URL paths for all the HCM REST resources use the root context value hcmRestApi.

The following table lists examples of URL path changes from R12 to R13.

REST Service	URL Path in R12	URL Path R13 Onwards
Employees	https://servername.fa.us2.oraclecloud.com/hcmCoreApi/resources/11.12.1.0/emps	https://servername.fa.us2.oraclecloud.com/hcmRestApi/resources/11.13.18.05/emps
Grades	https://servername.fa.us2.oraclecloud.com/hcmCoreSetupApi/resources/11.12.1.0/grades	https://servername.fa.us2.oraclecloud.com/hcmRestApi/resources/11.13.x.x/grades
Time Event Requests	https://servername.fa.us2.oraclecloud.com/hcmWorkforceMgmtApi/resources/11.12.1.0/timeEventRequests	https://servername.fa.us2.oraclecloud.com/hcmRestApi/resources/11.13.x.x/timeEventRequests
Wellness Activities	https://servername.fa.us2.oraclecloud.com//hcmWorkforceReputationApi/resources/11.12.1.0/wellnessActivities/	https://servername.fa.us2.oraclecloud.com/hcmRestApi/resources/11.13.x.x/wellnessActivities

To ensure backward compatibility, Oracle Applications Cloud automatically redirects the REST service calls that contain the older root context values. For example, if a current version (11.13.x.x) REST service call is:

https://servername.fa.us2.oraclecloud.com/hcmCoreApi/resources/11.13.x.x/emps

The call is automatically redirected as:

https://servername.fa.us2.oraclecloud.com/hcmRestApi/resources/11.13.x.x/emps

Although redirecting the REST service calls happens automatically, it's highly recommended that you update the client applications to use the correct revised URL paths. Don't rely exclusively on the redirect functionality.