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
- On the Rational® ClearQuest® Web
toolbar, click the arrow next to New Change Request and
select New REST URI. The
New REST URI template window opens.
- Select Find a record from the REST
URI Type list.
- Optional: To add Rational ClearQuest Web
login parameters to the REST URI, select Automatically
log in.
- Optional: To include the banner, workspace tree, and main
toolbar in the window that opens when the REST URI runs, select Include
the banner, workspace tree, and main toolbar.
- Click Create. The
REST URI template appears in the REST URI Template field.
- Copy the template into a text editor and replace the placeholders {{recordId}}, {{loginid}},
and {{password}} with appropriate values.
Optional:
Change the default format for the resource request from HTML to XML or ATOM.
- Copy the modified template into your web application or
another Web browser window.
- Click Reset to create a new REST
URI template or Close to exit.
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 ClearQuest Web server host system. This value
is defined when the REST URI template is created.
- YourConnection
- Your ClearQuest connection. This value is defined when the REST
URI template is created.
- YourUserDB
- Your ClearQuest 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 to XML or ATOM,
if desired.
- {{loginid}}
- Replace this placeholder with logon ID.
- {{password}}
- Replace this placeholder with your password.