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

/AgentWeb/api/elementmanager/export/EMPackages

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

https://mysite.example.com/AgentWeb/api/elementmanager/export/EMPackages

URL Syntax:

Access the Oracle B2C Service Element Manager REST APIs using the following URL syntax:

https://your_site_interface/AgentWeb/api/elementmanager/module/resource[/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.

module

The name of the module, for example, export, import, search.

resource

The name of the resource, for example, EMPackages, EMElements.

resource_id

The primary key identifier of the instance of the resource. Must be an integer, for example, 100045.

query_parameters

The query parameters where allowed, for example, fields or download.

For example:

https://mysite.example.com/AgentWeb/api/elementmanager/export/EMPackages/100045