Creating REST URIs to find records
You can create REST URIs to find records in your user database by linking directly to the records.
About this task
To create a REST URI to find a record:
Procedure
Example
Example
The following REST URI template to find a record was created by using the New REST URI wizard.
http://CQWebServerHost/cqweb/restapi/YourConnection/YourUserDB/RECORD/{{recordId}}?format=HTML&loginId={{loginid}}&password={{password}}
The
variables and template placeholders have the following meanings:
- CQWebServerHost
- Web address of your HCL Compass Web server host system. This value is defined when the REST URI template is created.
- YourConnection
- Your HCL Compass connection. This value is defined when the REST URI template is created.
- YourUserDB
- Your HCL Compass user database. This value is defined when the REST URI template is created.
- {{recordId}}
- Replace this placeholder with the record ID to find.
- format
- The default format for the resource request is
HTML
. You can change the format toXML
orATOM
, if desired. - {{loginid}}
- Replace this placeholder with logon ID.
- {{password}}
- Replace this placeholder with your password.