Welcome
Extending product function
Learn how to extend the product.
Programming with the Rational® ClearQuest® OSLC CM REST API
Learn how to use ClearQuest® CM REST API that supports both, OSLC v1 and v2.
User Interface preview
You can request information about the User Interface (UI) preview by asking for the application/x-oslc-compact+xml content type on a record URI.

IBM ClearQuest 10.0.9
Overview
Learn general information about the product.
Installing
Learn how to install the product.
Upgrading and migrating
Learn how to upgrade and migrate data for the product.
Administering
Learn how to administer the product.
Reporting
Learn how to generate reports for the product.
Developing
Learn how to develop schemas by using the Rational® ClearQuest® Designer.
Managing change and releases
Learn how to manage change and release in the product.
Integrating
You can integrate Rational® ClearQuest® with other software by adding packages to existing schema.
Extending product function
Learn how to extend the product.
- Programming with the Rational® ClearQuest® OSLC CM REST API
  Learn how to use ClearQuest® CM REST API that supports both, OSLC v1 and v2.
  - Using the Rational® ClearQuest® OSLC CM REST API
    The Rational® ClearQuest® OSLC 1.0 and OSLC 2.0 REST API is a RESTful (Representational State Transfer) interface that adheres to the Open Services for Lifecycle Collaboration (OSLC) 1.0 and 2.0 Core and Change Management (CM) specifications.
  - Authentication
    DevOps Code ClearCase® OSLC-CM REST APIs support both Basic Access Authentication and OAuth for authenticating users.
  - Resource Shapes
    Rational® ClearQuest® helps you to fully customize your records. You can define your own record types and pick what fields you want defined for those types.
  - Query Capabilities
    You can use the query capabilities to find records that match your search criteria.
  - Dialogs
    You can embed dialogs in your applications by using OSCL providers.
  - User Interface preview
    You can request information about the User Interface (UI) preview by asking for the application/x-oslc-compact+xml content type on a record URI.
- Programming with Rational® ClearQuest® CM API
Reference
Review reference information for the product.
Tutorials

User Interface preview

You can request information about the User Interface (UI) preview by asking for the application/x-oslc-compact+xml content type on a record URI.

Request

GET /cqweb/oslc/repo/DOC/db/SAMPL/record/16777224-33554433 HTTP/1.1
Host: quagmire.rtp.raleigh.ibm.com
OSLC-Core-Version: 2.0
Accept: application/x-oslc-compact+xml

Response

HTTP/1.1 200 OK
OSLC-Core-Version: 2.0
Content-Type: application/x-oslc-compact+xml; charset=UTF-8
Transfer-Encoding: chunked

<?xml version="1.0" encoding="UTF-8"?>
<rdf:RDF xmlns="http://open-services.net/ns/" xmlns:dc="http://purl.org/dc/terms/" xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#">
<Compact rdf:about="http://quagmire.rtp.raleigh.ibm.com/cqweb/oslc/repo/DOC/db/SAMPL/record/16777224-33554433">
<dc:title>SAMPL00000001: spelling error in login screen</dc:title>
<shortTitle>SAMPL00000001</shortTitle>
<icon rdf:resource="http://quagmire.rtp.raleigh.ibm.com/cqweb/oslc/repo/DOC/db/SAMPL/record/16777224-33554433/icon"/>
<largePreview>
<Preview>
<document rdf:resource="http://quagmire.rtp.raleigh.ibm.com/cqweb/oslc/repo/DOC/db/SAMPL/record/16777224-33554433/preview"/>
<hintWidth>600px</hintWidth>
<hintHeight>500px</hintHeight>
</Preview>
</largePreview>
</Compact>
</rdf:RDF>

The preview itself is available as the document property of the Preview resource. The preview shows the current value for fields on the first tab of the modify record form for the record type and gives users a way to view other tabs.