This is a landing page for the various API wiki pages that exist on Jazz.net development wiki as well as a central collective page of the existing APIs that are available for integrating programmatically with our CLM products.
Please see the
IBM Support Statement for CLM APIs. APIs are supported differently than CLM products.
General OSLC and CLM API information
OSLC Workshop
OSLC and REST API "cheat sheet"
OSLC GitHub repository
Eclipse Lyo - Java framework with sample libraries and reference implementations for OSLC
iotp-adaptor - An OSLC adapter for IBM Watson
IoT Platform and Bluemix resources, created using Lyo Designer
(this is a working example of integrating with CLM available as an example in source code).
It includes sample or open source code for common operations such as authenticating with CLM with OAuth.
Note: It works with non-configuration management-enabled CLM systems (aka "opt-out" DNG and RQM).
Jazz Foundation
Foundation APIs are available in CLM applications that support those Foundation services.
Jazz REST Services home
Jazz Foundation Process API
JAF SDK Main Page
Jazz Foundation SDK download page
Authentication of a native client with a Jazz-based application
DOORS Next Generation
Global Configuration Management REST API
Documentation for the Global Configuration Management REST API can be found at
https://host:port/gc/doc/scenarios. You must have the GC application installed to access this link.
This API is a collection of REST services that client applications use to create and update components, create new streams, create baselines, update a stream to match a baseline, and other operations. REST client applications can use the API to programmatically perform many of the operations that are usually done through the GCM web user interface. See
RM Enhancement 384433.
DNG Server API Documentation
DNG Client Extension API
DNG Module API
DNG Reportable REST API - v6.0 or higher
RRC Reportable REST API - v4.0.x thru v5.0.2
Extending requirements functionality (video)
RM Extensions Examples version 6.0.5
RM OSLC Specification 2.0
Rational Team Concert
What APIs are available for RTC and what can you extend?
RTC SDK
6.0.1: OSLC API Changes for Enumerations
RTC SDK changes for RTC 6.0.3
RTC Plain Java APIs
Consuming Rational Team Concert’s OSLC Change Management V2 Services
Rational Quality Manager
RQM Reportable REST API
OSLC QM V2 API
Reporting
A look inside LQE and Report Builder
Integrating external data sources with LQE and Report Builder
RTC Reportable REST API
RQM Reportable REST API
DNG Reportable REST API
Plain Java Client or Jazz APIs
The "official" Jazz API is available for download on the downloads page, in the Plain Zips section, under Plain Java Client Libraries and Plain Java Client Libraries API Documentation. The article
Rational Team Concert plain Java API's is an introduction into how they work. Customers wishing to write process extensions for their Jazz implementation should begin with the
RTC extensions workshop, the
Process enactment workshop, and the
OSLC workshop. This will help them better understand the various different options for extending and enhancing the Jazz solution, and will provide valuable insight into how to implement the needed customizations.
(Global) Configuration Management
GCM is a provider of global configurations as defined by the OSLC Configuration Management draft specification; RTC SCM, DNG, and RQM are providers of local configurations. These applications implement the appropriate APIs from that specification.
The OSLC Configuration Management specification is still in draft status; there are no published versions. Once a version has been published, a link will be placed here. Meanwhile, the latest draft in version control may be found at
https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/config/#_trunk_specs_config_.
The Global Configuration Management REST API is documented in your local CLM installation at
https://[server]:[port]/gc/doc/scenarios
External links:
Additional contributors: