Application Reportable REST APIs

Each Collaborative Lifecycle Management (CLM) application has a reportable REST API, which provides access to the data that is stored in each application’s repository.
Figure 1. Data flow process: Application Reportable REST APIs

Full data flow diagram with the Reportable REST API process highlighted.

Image key:
  • CLM = Rational® solution for Collaborative Lifecycle Management
  • QM = Quality Management application
  • CCM = Change and Configuration Management application
  • RM = Requirements Management application
  • UI = User interface
  • REST = Representational state transfer
  • API = Application programming interface
  • XML = Extensible markup language
  • JDBC = Java™ database connector
  • ETL = Extract, tranform, and load
  • ODS = Operational data store

Representational state transfer (REST) is an architecture that allows data to be accessed through a set of requests. The API (application programming interface), or web service, that is provided with each application uses HTTP (hypertext transfer protocol) to make these requests. The web requests are in the form of HTTP URLs (uniform resource locator). Each CLM application datum has a specific URL associated with it, and depending on the syntax of the URL, that datum can be accessed and represented in variety of ways. Each application’s REST schema defines the types and specific points of data that can be requested and the syntax that must be used in order to access them in a particular way. For example, the Quality Management REST API schema includes test plans, test cases, and so on as reportable points of data and includes a set of rules about how the request URL must be formed in order to determine exactly what and how the data should be accessed.

Because the application data can be accessed using HTTP web requests, any tool that can form and run these web requests can report on the data (assuming that it has privileged access to it). The Cognos’ development intelligence report authoring tools (Report Studio and Query Studio), which are included with IBM® Cognos® Business Intelligence, and the Rational Publishing Engine document-style report authoring tools (Document Studio) can form and run these requests.

Each CLM application has a unique reportable REST APIs. Requirements Management, Change and Configuration Management, and Quality Management, and the Jazz™ Team Server each have a REST API that can be used to access the data that is created using the applications. Each application also has one or more associated data collection jobs, which use the HTTP web requests to access the data.

The REST APIs are used by the data collection job to extract data from the application data storage, which is later loaded into the data warehouse. The REST APIs can also be used to pull live data directly into reports.

The output of the REST API requests is XML data, which cannot yet be understood by the ETL files because the ETL mappings only understand input in a database format.

Related concepts:
Application reportable REST APIs
Related reference:
Change and configuration management reportable REST API
Quality management reportable REST API
Requirements management reportable REST API

video icon Watch videos

CLM playlist
Jazz.net channel
User Education channel

learn icon Learn more

CLM learning circle
Agile learning circle
Learning circles

ask icon Ask questions

Jazz.net forum
developerWorks forums

support icon Get support

Support Portal
Deployment wiki
Support blog