URL Path

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 B2C Service administrator. For example:

https://mysite.example.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:

/services/rest/connect/v1.4/accounts

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

https://mysite.example.com/services/rest/connect/v1.4/accounts

Here v1.4 is the REST API version. If a resource path doesn't contain a version number, then it resolves to the latest version of the resource.

URL Syntax:

Access the Oracle B2C Service REST resources using the following URL syntax:

https://your_site_interface/services/rest/connect/version/resource[/resource_id][/child_resource][/child_resource_id][?query_parameters]

The following table describes the URL syntax.

Parameter	Description
your_site_interface	The domain name of your interface, such as mysite.example.com.
version	The API version. In the August 2017 release, support has been added for v1.4. Both v1.4 and latest point to CCOM version 1.4.
resource	The name of the resource, for example, incidents.
resource_id	The primary key identifier of the instance of the resource. Must be an integer, for example, 5.
child_resource	The name of the child resource, for example, address or name.
child_resource_id	The primary key identifier of the instance of the child resource. Must be an integer, for example, 7.
query_parameters	The query parameters where allowed, for example, fields or download. For more information, see Supported Query Parameters.

For example:

https://mysite.example.com/services/rest/connect/v1.4/accounts/2