Business Entity Services Guide

10.5 HotFix 2
- 10.5
- 10.4 HotFix 3
- 10.4 HotFix 2
- 10.4 HotFix 1
- 10.4
- 10.3 HotFix 3
- 10.3 HotFix 2
- 10.3 HotFix 1
- 10.3

Back Next

REST Uniform Resource Locator

You use a REST URL to make REST calls for business entity services.

The REST URL has the following syntax:

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

The URL has the following fields:

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.

The following URL is an example of a REST URL for a child record with a depth of 2:

http://localhost:8080/cmx/cs/localhost-orcl-DS_UI1/Person/798243/BillAddresses/121522.json?depth=2

Parameters are case sensitive. Ensure the case of the parameter names in the REST URL matches the case of the parameter names in the REST configuration.

Rename Saved Search

Table of Contents

Business Entity Services Guide

Business Entity Services Guide

REST Uniform Resource Locator

REST Uniform Resource Locator