Integrating with Rational Publishing Engine and other REST clients

1. To find the URL to either the queries or reports service, follow the steps in Discovering services.
2. Type that URL into an Internet Explorer 7 or Firefox 3 or newer browser window to browse your queries or reports.
3. Locate the query or report you want, and then copy the URL.

   Reports that require additional user input, such as trend analysis reports, are unavailable. If using Internet Explorer 6, the document you downloaded contains URLs to top-level folders. Type those URLs in the browser window to find the contents of those folders. Repeat this process until you find the URL to the query or report you want.

4. Optionally, you can customize the exact attributes that are returned from the URL by passing the oslc_cm.properties parameter as described in the API specification. This step is not normally necessary with Rational Publishing Engine. It automatically requests that the attributes it needs based on your document specification.
5. When creating your document specification in Rational Publishing Engine, use the URL you copied as the URI of your REST data source. Also, be sure to type the user name and password of the user you want to run the query or report.

When designing your document in Rational Publishing Engine Document Studio, you need a data source schema that describes the CRs returned from your query or report. To retrieve the schema, use the same URL for your query or report, but append the following line to it:

?metadata=schema

For example: .../reports/personal/Assigned%20CRs?metadata=schema

You can also use the metadata=schema parameter with CRs returned from the simpleQuery service when you prefer to embed an OSLC-CM query directly into your URL. When browsing the schema in Rational Publishing Engine, the CR element is located under feed/entry/content/ChangeRequest.