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

/crmRestApi/resources/11.13.19.01/opportunities

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

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.19.01/opportunities

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 accounts resource, the context root for the REST API web module is crmRestApi and the version is 11.13.19.01. If a resource path doesn't contain a version number, then it resolves to the latest version of the resource.

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 on www.w3schools.com.