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.