http://<
host>:<
port>/<
context>/<
database ID>/<
path>

host

The host that is running the database.

port

Port number that the database listener uses.

context

The context for the business entity, search, query, match, task, and hierarchy APIs is

cmx/cs

.

The context for the match columns API is

cmx

.

The context for file APIs is

cmx/file

.

The context for task APIs is

cmx/task

.

The context for bulk task administration APIs is

cmx/task/operations

.

The context for bulk relationship APIs is

cmx/bulk

.

The context for chart report APIs is

cmx/report

.

In a Hosted MDM environment, include the tenant name in the context. For example, the context can be

<tenant name>/cmx/cs

or

<tenant name>/cmx/file

.

database ID

ID of the ORS as registered in the Databases tool in the Hub Console.

path

The object that you want to use the API on, such as records, tasks, or files.

If the URL is for a root record, the path is the root object name followed by a unique identifier.

An example of a path for a Person root record is

Person/798243.json.

If the URL is for a record that is a direct child of the root object, the path also includes the child record name and a unique identifier.

An example of a path for a billing address record that is a child of a Person root record is:

Person/798243/BillAddresses/121522.json.

If the URL is for a child record that is at a depth of two or greater, the path also includes the depth.