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 accounts, the resource path is as follows:

/crmRestApi/resources/11.13.18.05/accounts

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

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/accounts

We recommend using one of these API versions in the resource path: 11.13.18.05 or v1 (which is the latest version). If a resource path doesn't contain a version number, then a 404 error occurs.

If the same resource also has the v1 version, the URL path would be in a slightly different format:

https://<servername>/api/boss/data/objects/<module segments>/v1/<service name>

We recommend using the latest API version, which is 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.