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 announcements, the resource path is as follows:
/fscmRestApi/resources/11.13.18.05/announcements
So, the combined request URL for the announcements resource becomes:
https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/announcements
Note that the resource path typically contains the context root for the REST API web module and the REST
API version of a resource. For example, for the announcements resource, the context root
for the REST API web module is fscmRestApi
and the version is 11.13.18.05
.
https://<servername>/api/boss/data/objects/<module segments>/v1/$openapi/<resource>
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.
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.