IBM Support

Sample URLs for login to ClearQuest Web without prompting for web login screen

Question & Answer


Question

What are some examples of the parameters that are available to automate the login for IBM Rational ClearQuest Web 7.1.x and 8.0?

Answer

A new REST (Representational State Transfer) feature is introduced in ClearQuest Web 7.1. You can create Web-based REST URI templates to run ClearQuest actions from your Web browser. For more information, refer to the ClearQuest Information Center topic Creating REST URIs to log on and perform common tasks.


The following are the formats and sample URLs:

Logon:

http://localhost/cqweb/restapi/{{dbset}}/{{user_db}}?format=HTML&loginId={{loginid}}&password={{password}}


Example:

http://localhost/cqweb/restapi/7.0.0/SAMPL?format=HTML&loginId=admin&password=admin

Note: The below REST URI templates are setup to automatically log in. They do not include the ClearQuest banner, workspace tree, and main toolbar. To include them, remove the &noframes=true parameter at the end.


Find a record:

http://localhost/cqweb/restapi/{{dbset}}/{{user_db}}/RECORD/{{recordId}}?format=HTML&loginId={{loginid}}&password={{password}}&noframes=true


Example:

http://localhost/cqweb/restapi/7.0.0/SAMPL/RECORD/SAMPL00000001?format=HTML&loginId=admin&password=admin&noframes=true


View a record:

http://localhost/cqweb/restapi/{{dbset}}/{{user_db}}/RECORD/{{recordId}}?format=HTML&recordType={{recordType}}&loginId={loginid}}&password={{password}}&noframes=true


Example:

http://localhost/cqweb/restapi/7.0.0/SAMPL/RECORD/SAMPL00000001?format=HTML&recordType=Defect&loginId=admin&password=admin&noframes=true


Submit a record:

http://localhost/cqweb/restapi/{{dbset}}/{{user_db}}/RECORD?format=HTML&recordType={{recordType}}&fieldsXml=&autoSave=false&loginId={{loginid}}&password={{password}}&noframes=true


Example:

http://localhost/cqweb/restapi/7.0.0/SAMPL/RECORD?format=HTML&recordType=Defect&fieldsXml=&autoSave=false&loginId=admin&password=admin&noframes=true

If you want to automatically fill in the fields using a formatted URL, you can modify the &fieldsXml= parameter.


Example:

http://localhost/cqweb/restapi/7.0.0/SAMPL/RECORD?format=HTML&recordType=Defect&fieldsXml=<Field><Name>Headline</Name><Value><![CDATA[]This is my headline]></Value></Field>&autoSave=false&loginId=admin&password=admin&noframes=true


Modify a record:

http://localhost/cqweb/restapi/{{dbset}}/{{user_db}}/RECORD/{{recordId}}?format=HTML&recordType=Defect&action={{action}}&fieldsXml=&autoSave=false&loginId={{loginid}}&password={{password}}&noframes=true


Example:

http://localhost/cqweb/restapi/7.0.0/SAMPL/RECORD/SAMPL00000001?format=HTML&recordType=Defect&action=Modify&fieldsXml=&autoSave=false&loginId=admin&password=admin&noframes=true

If you want to automatically fill in the fields using a formatted URL, you can modify the &fieldsXml= parameter.


Example:

http://localhost/cqweb/restapi/7.0.0/SAMPL/RECORD/SAMPL00000001?format=HTML&recordType=Defect&action=Modify&fieldsXml=<Field><Name>Headline</Name><Value><![CDATA[{{Enter}}]]></Value></Field>&autoSave=false&loginId=admin&password=admin&noframes=true


For queries, reports, and charts, the fastest way to generate the URL is by the REST URI template (New REST URI).

Run a query:

Example:
Use case: Run the "All Defects" query under Public Queries.

http://localhost/cqweb/restapi/7.0.0/SAMPL/QUERY/Public%20Queries/All%20Defects?format=HTML&loginId={{loginid}}&password={{password}}&noframes=true


Run a report:

Example:
Use case: Run the "Defect Summary (State)" report under Public Queries.

http://localhost/cqweb/restapi/7.0.0/SAMPL/REPORT/Public%20Queries/Reports/Defect%20Summary%20(All)?format=HTML&loginId={{loginid}}&password={{password}}&noframes=true


Run a chart:

Example:
Use case: Run the "Defect Counts by State, Day" chart under Public Queries/Trend Charts/Submitted.

http://localhost/cqweb/restapi/7.0.0/SAMPL/CHART/Public%20Queries/Trend%20Charts/Defect%20Counts%20by%20State,%20Day?format=HTML&loginId={{loginid}}&password={{password}}&noframes=true


At this time, there is no way to retrieve the Get Logon Stats screen from a formatted URL in ClearQuest Web 7.1.x nor in 8.0.


[{"Product":{"code":"SSSH5A","label":"Rational ClearQuest"},"Business Unit":{"code":"BU053","label":"Cloud & Data Platform"},"Component":"Web Client (7.1)","Platform":[{"code":"PF002","label":"AIX"},{"code":"PF010","label":"HP-UX"},{"code":"PF016","label":"Linux"},{"code":"PF027","label":"Solaris"},{"code":"PF033","label":"Windows"}],"Version":"7.1;7.1.1;7.1.2;8.0","Edition":"","Line of Business":{"code":"LOB45","label":"Automation"}}]

Document Information

Modified date:
16 June 2018

UID

swg21373106

Page Feedback