(r13) ELMProductAPILanding < Deployment

Engineering Lifecycle Management Wiki - Deployment
Community information and contribution guidelines
~~EditAttach~~Printable
TWiki > Deployment Web > DeploymentIntegrating > CLMProductAPILanding > ELMProductAPILanding
Revision 13 - 2025-06-09 - 09:31:18 - ErzhanTemirMamyrov
<div id="header-title" style="padding: 10px 15px; border-width:1px; border-style:solid; border-color:#FFD28C; background-image: url(<nop>https://jazz.net/wiki/pub/Deployment/WebPreferences/TLASE.jpg); background-size: cover; font-size:120%">
---+!! Engineering Lifecycle Management API Landing page
%DKGRAY% Authors: Main.RosaNaranjo, Main.JimRuehlin, Main.MichaelRowe<br>
Build basis: 7.0.x
%ENDCOLOR%</div></sticky>

<!-- Page contents top of page on right hand side in box -->
<sticky><div style="float:right; border-width:1px; border-style:solid; border-color:#DFDFDF; background-color:#F6F6F6; margin:0 0 15px 15px; padding: 0 15px 0 15px;">
%TOC{title="Page contents"}%
</div></sticky>

<sticky><div style="margin:15px;"></sticky>

---++ Overview
This is a landing page for the various API wiki pages that exist on Jazz.net as well as a central collective page of the known APIs that are available for integrating programmatically with our Engineering Lifecycle Management (ELM) products. It serves as a convenience for accessing API information about ELM products and is not guaranteed to have up-to-the-minute information. See the official API specifications for each ELM component for complete information.
<br>
Please see the [[https://www.ibm.com/support/pages/node/284221][IBM Support Statement for ELM APIs]]. APIs are supported differently than ELM products.
-------
%RED%
IBM strongly advises that any scripts that customers develop using APIs be tested in a staging environment prior to use in a production environment.  Scripts can have unintended performance or other consequences and thus should be highly scrutinized prior to deployment on production systems.
%ENDCOLOR%
See [[https://jazz.net/wiki/bin/view/Deployment/AutomationsBestPractices][API Automation Best Practices]]
-------

---++ General OSLC and ELM API information

*Note all ELM servers have some level of API documentation located at <verbatim>https://<server>:<port>/<application-context>/doc</verbatim>*
<br>

%TABLE{id="Server" sort="on" initsort="1" headerrows="1" tableborder="3" cellpadding="5" cellspacing="2" columnwidth="15%, 30%, 45%, 10%" tablewidth="80%"}%
|  Application-Context  | Links  |  Additional Details  |  Last Updated  |
| 1 - Overview | [[https://jazz.net/jts/doc][/jts/doc]] | JTS Documentation Root | Release specific |
| JTS | [[https://jazz.net/jts/doc/services][/jts/doc/services]] | JTS Services Documentation | Release specific |
| CCM | [[https://jazz.net/jazz/doc/services][/ccm/doc/services]] | CCM Services Documentation (override this link with our own servers root) | Release specific |
| DCC | [[https://jazz.net/dcc/doc/services][/dcc/doc/services]] | DCC Services Documentation | Release specific |
| GC | [[https://jazz.net/gc/doc/services][/gc/doc/services]] | GC Services Documentation | Release specific |
| QM | [[https://jazz.net/qm/doc/services][/qm/doc/services]] | QM Services Documentation (override this link with our own servers root) | Release specific |
| RM | [[https://jazz.net/rm/doc/services][/rm/doc/services]] | RM Services Documentation | Release specific |
<br>

The following table contains key concepts you should become familiar with when working with ELM and OSLC based applications' APIs.
<br>
%TABLE{id="General" sort="on" initsort="1" headerrows="1" tableborder="3" cellpadding="5" cellspacing="2" columnwidth="15%, 30%, 45%, 10%" tablewidth="90%"}%
|  Component  |  Key links  |  Additional Details  |  Last Updated  |
| Workshop | [[https://jazz.net/library/article/635][OSLC Workshop]] | Covers CM and RM 2.0 specifications, Build basis 3.0-6.0 | April 1, 2016 |
| Guide | [[https://oslc.github.io/developing-oslc-applications][Guide for writing OSLC integrations]] | OSLC application development guide |   |
| Cheat Sheet | [[https://clmpractice.org/2014/12/03/oslc-and-rest-apis-cheat-sheets-how-to-for-querying-rtc-and-dng-resources][OSLC and REST API "cheat sheet"]] | External Blog | March 12, 2014 |
| Specification | [[https://jazz.net/wiki/bin/view/Main/RootServicesSpec][ELM Root Services Specification]] | Key details document to understand API discovery process | May 25, 2011 |
| OSLC | [[https://github.com/OSLC][OSLC GitHub repository]] | GitRepo | Ongoing |
| Eclipse | [[https://www.eclipse.org/lyo][Eclipse Lyo]] | Eclipse Lyo is an improved Java framework with sample libraries and reference implementations for creating OSLC integrations | June 22, 2023 |
| OSLC | [[https://github.com/OSLC/iotp-adaptor][IoT Connector]] | IoT Connector is a working sample of an OSLC adapter for IBM Watson IoT Platform created using Lyo Designer. It's a working example and source code for integrating with ELM and includes common operations such as authenticating with ELM using OAuth. It works with non-configuration management-enabled CLM systems (aka "opt-out" DN and ETM). | 2021 |
<br>

---++ Jazz Foundation

Foundation APIs are available in ELM applications that support those Foundation services.

%TABLE{id="JAF" sort="on" initsort="1" headerrows="1" tableborder="3" cellpadding="5" cellspacing="2" columnwidth="15%, 30%, 45%, 10%" tablewidth="90%"}%
|  Component  |  Key links  |  Additional Details  |  Last Updated  |
| Jazz Rest Services | [[https://jazz.net/wiki/bin/view/Main/JazzRESTServicesMain][Jazz REST Services home]] | Landing apge for key services details | September 26, 2009 |
| Process API | [[https://jazz.net/wiki/bin/view/Main/DraftTeamProcessRestApi][Jazz Foundation Process API]] | Build basis 4.0.3 | December 15, 2023 |
| Foundation SDK | [[https://jazz.net/wiki/bin/view/Main/JAFSdk][Documentation]] | Build basis 4.x | August 29, 2012 |
| ^ | [[https://jazz.net/downloads/jazz-foundation/][Download]] | Download to match your server | Ongiong |
| Authentication | [[https://jazz.net/wiki/bin/view/Main/NativeClientAuthentication][Authentication of a native client with a Jazz-based application]] | Details on authentication techniques across all APIs. | June 11, 2018 |
| User Profile | [[https://jazz.net/wiki/bin/view/Main/FetchUserProfile][Fetch User Profile]] | *NEW API* | Jauary 9, 2024 |
| Readiness API | [[https://jazz.net/wiki/bin/view/Main/ReadinessProbe][Documentation]] | Build basis: 7.0.2 | September 30, 2021 |
| Rest API | [[https://jazz.net/jts/doc/scenarios][JTS Scenarios]] | This document provides a number of scenario based examples of common uses of the API. |  |
<br>

---++ Global Configuration Management

GCM is a provider of global configurations as defined by the OSLC Configuration Management specification; EWM SCM, DOORS Next, ETM, and RMM are providers of local configurations. These applications implement the appropriate APIs from that specification.

Documentation for the Global Configuration Management REST API can be found at https://[server]:[port]/gc/doc/scenarios. You must have the GC application installed to access this link.

%TABLE{id="GCM" sort="on" initsort="1" headerrows="1" tableborder="3" cellpadding="5" cellspacing="2" columnwidth="15%, 30%, 45%, 10%" tablewidth="90%"}%
|  Component  |  Key links  |  Additional Details  |  Last Updated  |
| OSLC Configuration Management Specification | [[https://docs.oasis-open-projects.org/oslc-op/config/v1.0/os/oslc-config-mgt.html][Specifications page]] | Release 1.0 GCM Specifications | July 23, 2023 |
| Rest API | [[https://jazz.net/gc/doc/scenarios][Global Configuration Management Scenarios]] | This document provides a number of scenario based examples of common uses of the API.  |  |
| Client Extension | [[https://jazz.net/wiki/bin/view/Main/GcmExtensionApi][GCM Client Extension API]] |  |  |
<br>

---++ Engineering Requirements Management DOORS Next (DN)

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.

%TABLE{id="DN" sort="on" initsort="1" headerrows="1" tableborder="3" cellpadding="5" cellspacing="2" columnwidth="15%, 30%, 45%, 10%" tablewidth="90%"}%
|  Component  |  Key links  |  Additional Details  |  Last Updated  |
| RM Service Provider | [[https://www.ibm.com/docs/en/engineering-lifecycle-management-suite/doors-next/7.0.3?topic=services-rm-as-oslc-service-provider][RM as an OSLC service provider]] | Documentation in IBM Docs | Release Dependent |
| OSLC Article | [[https://jazz.net/library/article/1197][Using OSLC capabilities in the RM application]] | Describes OSLC | January 17, 2013 |
| Server API | [[https://jazz.net/wiki/bin/view/Main/DNGServerAPI][Documentation]] | Supporting version 6.X and newer | February 13, 2024  |
| Client API | [[https://jazz.net/wiki/bin/view/Main/RMExtensionsMain][Extension API Documentation]] |   | February 13, 2024 |
| Module API | [[https://jazz.net/wiki/bin/view/Main/DNGModuleAPI][Documentation]] |   | December 5, 2017 |
| Reportable Rest API | [[https://jazz.net/wiki/bin/view/Main/DNGReportableRestAPI][DN Reportable REST API - v6.0 or higher]] | No significant changes for 7.X | March 17, 2023 |
| Reportable Rest API | [[https://jazz.net/wiki/bin/view/Main/RRCReportableRestAPI][RRC Reportable REST API - v4.0.x thru v5.0.2]] | No longer supported | August 6, 2018 |
| Video Tutorial | [[https://jazz.net/library/article/87230][Extending requirements functionality]] | Demo from DN 4.0.5 | March 09, 2017 |
| Extension Examples | [[https://jazz.net/wiki/bin/view/Main/RMExtensionsExamples703][Version 7.0.3]] |  | February 13, 2024 |
| !ReqIF API | [[https://jazz.net/wiki/bin/view/Main/DNGReqIF][ReqIF API v1.0]] | New for 6.0.6.1 | October 31, 2019 |
| Rest API | [[https://jazz.net/rm/doc/scenarios][DN Scenarios]] | This document will provide scenario based examples of common uses of the API. |  |
| DNG Change Set Contents | [[https://jazz.net/wiki/bin/view/Main/DNGChangesetContentsApiOverview][API Overview]] | This document will provide scenario based examples of common uses of the API. |  02-15-2024 |
<br>

---++ Engineering Workflow Management (EWM / Formerly RTC)

%TABLE{id="EWM" sort="on" initsort="1" headerrows="1" tableborder="3" cellpadding="5" cellspacing="2" columnwidth="15%, 30%, 45%, 10%" tablewidth="90%"}%
|  Component  |  Key links  |  Additional Details  |  Last Updated  |
| !WorkItem (Resource Oriented) | [[https://jazz.net/wiki/bin/view/Main/ResourceOrientedWorkItemAPIv2][Documentation]] | This API  allows you to get, create, modify and query work items and other resources using standard HTTP methods, allowing integrations with minimal requirements for the clients. | Feburary 2, 2021 |
| Blog post | [https://rsjazz.wordpress.com/2021/09/29/using-the-ewm-rest-and-oslc-apis/]] | Using EWM Rest and OSLC APIs | September 29, 2021 |
| Blog post | [[https://rsjazz.wordpress.com/2013/03/14/what-apis-are-available-for-rtc-and-what-can-you-extend/][What APIs are available for EWM and what can you extend?]] | !https://rsjazz.wordpress.com has a large number of articles available on EWM APIs and SDK usage | March 14, 2013 |
| SDK | [[https://jazz.net/wiki/bin/view/Main/EwmSdk703][Document]] | 7.0.3 Release | October 26, 2023 |
| OSLC - Enumerations | [[CLMOSLCAPIChangesFor601][API Changes for Enumerations ]] | 6.0.1: OSLC | January 5, 2017 |
| Blog post | [[https://rsjazz.wordpress.com/2016/11/07/the-rtc-sdk-is-about-to-change-in-6-0-3/][RTC SDK changes for RTC 6.0.3]] | !https://rsjazz.wordpress.com has a large number of articles available on EWM APIs and SDK usage | November 7, 2016 |
| Java SDK | [[https://jazz.net/library/article/1229][Plain Java APIs]] | Article for RTC 4.0.1 | January 20, 2013 |
| OSLC | [[https://jazz.net/library/article/1001][Consuming EWM OSLC Change Management V2 Services]] | Introductory article on using EWM via OSLC | July 10, 2012 |
| Java | [[https://jazz.net/wiki/bin/view/Main/ProgrammaticLinkCreation][Programmatic Link Creation and new link type contribution]] | Introductory artcle on creating new links in EWM with Sample source code (RTC 1.x/2.x) | September 9, 2009 |
| Java | [[https://jazz.net/wiki/bin/view/Main/ProgrammaticWorkItemCreation][Programmatic WorkItem Creation]] | Introductory article on creating new workitems in EWM with Sample source code (RTC 1.x/2.x) | June 6, 2009 |
| Java | [[https://jazz.net/library/article/782/][Programmatic Defect Creation]] | Introductory article on creating a linked defect from a work item (RTC 3.x) | December 23, 2011 |
| SDK | [[https://jazz.net/wiki/bin/view/Main/CustomPreconditionsTable#operations][Extension Points and Operation ID’s]] | Build basis RTC 3.0.1.2 | September 9th, 2019 |
| Java | [[https://jazz.net/library/article/1229][Plain Java API’s Article]] | Build basis RTC 4.0.1 | January 30, 2013 |
| Configuration | [[https://jazz.net/library/article/1075#operations][Source control process recipes for Rational Team Concert – Source Control  Operations with Preconditions]] | An article on how to configure preconditions and operations in EWM's source control | June 9, 2017 |
| SDK | [[https://jazz.net/library/article/495][Creating Custom Operation Advisors]] | Build basis RTC 2.0.0.2 | August 25, 2010 |
| OSLC | [[https://jazz.net/library/article/1001][Consuming EWM’s OSLC Change Management V2 Services]] | Build basis RTC 4.0 | July 10, 2012 |
| OSLC | [[https://jazz.net/wiki/bin/view/Main/RTCAutomationOSLCPrototype][Automation OSLC Prototype]] | Prototype of services automation API | June 10, 2010 |
| OSLC | [[https://jazz.net/wiki/bin/view/Main/WorkItemAPIsForOSLCCM20][Work Items Service provider for OSLC 2.0 CM Specification]] | Build basis RTC 3.0.1 | May 24, 2018 |
| Reportable API | [[https://jazz.net/wiki/bin/view/Main/ReportsRESTAPI#Reportable_REST_API][Documentation]] | Build basis RTC 3.0.1 | August 4, 2015 |
| Reportable API | [[https://jazz.net/forum/questions/211156/how-consume-jazz-reportable-rest-api-programmatically-using-java/211320][Forum Question/Answer]] | How to consume Reportable REST API programmatically using Java | November 18, 2015 |
| Workshop | [[https://jazz.net/library/article/1000][Extensions Workshop]] | EWM Extentions Workshop material | May 7, 2021 |
<br>

---++ Rhapsody Model Manager

%TABLE{id="RMM" sort="on" initsort="1" headerrows="1" tableborder="3" cellpadding="5" cellspacing="2" columnwidth="15%, 30%, 45%, 10%" tablewidth="90%"}%
|  Component  |  Key links  |  Additional Details  |  Last Updated  |
| Reportable API | [[https://jazz.net/wiki/bin/view/Main/RMMReportableRestAPI][Documentation]] | The Rhapsody Model Manager server provides REST APIs for accessing information about Architecture Management artifacts for reporting, traceability, and coverage metrics.  | January 11, 2024 |
<br>

---++ Engineering Test Management (ETM / Formerly RQM)

%TABLE{id="ETM" sort="on" initsort="1" headerrows="1" tableborder="3" cellpadding="5" cellspacing="2" columnwidth="15%, 30%, 45%, 10%" tablewidth="90%"}%
|  Component  |  Key links  |  Additional Details  |  Last Updated  |
| Test Automation Adapter | [[https://jazz.net/wiki/bin/view/Main/RQMTestAutomationAdapterAPI][Documentation]] | Build basis 7.0 | May 27, 2020 |
| Reportable API | [[https://jazz.net/wiki/bin/view/Main/RqmApi][Documentation]] | The ETM Reportable Rest API provides full CRUD capabilities | October 23, 2023 |
| OSLC | [[https://jazz.net/wiki/bin/view/Main/RqmOslcQmV2Api][QM V2 API]] | Supported OSLC QM V2 API as supported by ETM | August 10, 2023 |
| Rest API | [[https://jazz.net/qm/doc/scenarios][QM Scenarios]] | This document will provide scenario based examples of common uses of the API. |  |
<br>

---++ Reporting

%TABLE{id="JRS" sort="on" initsort="1" headerrows="1" tableborder="3" cellpadding="5" cellspacing="2" columnwidth="15%, 30%, 45%, 10%" tablewidth="90%"}%
|  Component  |  Key links  |  Additional Details  |  Last Updated  |
| Article | [[https://jazz.net/library/article/91481][A look inside LQE and Report Builder]] | Describes how Lifecycle Query Engine and Report Builder process metadata from application to support reporting in ELM | February 2018 |
| Article | [[https://jazz.net/library/article/91450][Integrating external data sources with LQE and Report Builder]] | This article is intended for developers who want to contribute data from 3rd-party applications or external data sources to the LQE data source for reporting. It includes references and links to a companion article that describes how LQE and Report Builder process the metadata to support reporting. | March 2022 |
| REST API | [[https://jazz.net/wiki/bin/view/Main/RPEAPIDocumentation][Rest API]] | Pub Document Builder REST API page | February 19, 2024 |
| Reportable API | [[https://jazz.net/wiki/bin/view/Main/ReportsRESTAPI][EWM Documetation]] | EWM Reportable Rest API | August 4, 2015 |
| Reportable API | [[https://jazz.net/wiki/bin/view/Main/RqmApi][ETM Documenation]] | ETM Reportable Rest API | October 3, 2023 |
| Reportable API | [[https://jazz.net/wiki/bin/view/Main/DNGReportableRestAPI][DN Documentation]] | DN Reportable Rest API | March 17, 2023 |

---++ 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 [[https://jazz.net/library/article/1229][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 [[https://jazz.net/library/article/1000][RTC extensions workshop]], the [[https://jazz.net/library/article/1093][Process enactment workshop]], and the [[https://jazz.net/library/article/635][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.

---++!! Related topics: [[DeploymentWebHome][Deployment web home]]

---++!! External links:          

   * [[http://open-services.net/][OSLC community pages]]
   * [[http://open-services.net/bin/view/Main/RmSpecificationV2][OSLC RM Spec v2]]
   * [[http://open-services.net/bin/view/Main/QmSpecificationV2][OSLC QM Spec v2]]
   * [[https://tools.oasis-open.org/version-control/browse/wsvn/oslc-ccm/branches/2q2015/specs/config-mgt.html][OSLC Configuration Management domain: OASIS working draft]]
   * [[http://www.w3.org./RDF/][W3C: Resource Description Framework]]
   * [[http://www.w3.org/standards/semanticweb/data][W3C: Linked Data]]
   * [[https://rsjazz.wordpress.com/2013/03/14/what-apis-are-available-for-rtc-and-what-can-you-extend/][RSJazz - What API’s are Available for RTC and What Can You Extend?]]
   * [[https://rsjazz.wordpress.com/2013/02/28/setting-up-rational-team-concert-for-api-development/][RSJazz - Setting up Rational Team Concert for API Development]]
   * [[https://rsjazz.wordpress.com/2013/03/20/understanding-and-using-the-rtc-java-client-api/][RSJazz - Understanding and Using the RTC Java Client API]]
   * [[https://rsjazz.wordpress.com/interesting-links/][RSJazz - Links to other API related sources]]
   * [[https://michaelrowe01.com/index.php/day-job/ibm-elm/beginning-api-discovery-or-understanding-the-rootservices-document/][michaelrowe01 - Beginning API Discovery]]
   * [[https://michaelrowe01.com/index.php/day-job/ibm-elm/api-authentication-method-in-elm-oauth-1-0a/][michaelrowe01 - ELM Oauth 1.0a Example]]
   * [[https://michaelrowe01.com/index.php/day-job/ibm-elm/api-authentication-method-in-elm-oidc/][michaelrowe01 - ELM OIDC Example]]

---+++++!! Additional contributors: [[Main.RalphSchoon][Ralph Schoon]], Main.ToddDunnavant
<sticky></div></sticky>
Copyright © by IBM and non-IBM contributing authors. All material on this collaboration platform is the property of the contributing authors.
Contributions are governed by our Terms of Use. Please read the following disclaimer.
Dashboards and work items are no longer publicly available, so some links may be invalid. We now provide similar information through other means. Learn more here.