Creating REST URIs to run queries
You can create REST URIs to run queries.
About this task
Procedure
Example
Example
The following REST URI template to run a query was created by using the New REST URI wizard. In this example, the check box Automatically log in was selected to create the REST URI.
http://CQWebServerHost/cqweb/restapi/YourConnection/YourUserDB/QUERY/QuerySpecification?format=HTML&loginId={{loginid}}&password={{password}}&noframes=true
The
variables and template placeholders have the following meanings:
- CQWebServerHost
- Web address of your HCL Compass Web server host. 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.
- QuerySpecification
- The query specification that you selected in the Select a query field.
- format
- The default format for the resource request is
HTML
. You can change the format toXML
orATOM
, if desired. - {{loginid}}
- Replace this placeholder with your logon ID.
- {{password}}
- Replace this placeholder with your password.
- noframes
- If this value is
true
, the HCL Compass Web banner, workspace tree, and main toolbar do not appear when you run the REST URI to view the resource. Thenoframes
filter is relevant only ifformat=HTML
.