r10 - 2024-04-09 - 18:30:13 - MichaelRoweYou are here: TWiki >  Deployment Web > DeploymentIntegrating > CLMProductAPILanding > ELMProductAPILanding

Engineering Lifecycle Management API Landing page constantchange.png"

Authors: RosaNaranjo, JimRuehlin, MichaelRowe
Build basis: 7.0.x

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.
Please see the IBM Support Statement for ELM APIs. APIs are supported differently than ELM products.
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. See API Automation Best Practices

General OSLC and ELM API information

Note all ELM servers have some level of API documentation located at

https://<server>:<port>/<application-context>/doc

Application-Context Links Additional Details Last Updated
1 - Overview /jts/doc JTS Documentation Root Release specific
CCM /ccm/doc/services CCM Services Documentation (override this link with our own servers root) Release specific
DCC /dcc/doc/services DCC Services Documentation Release specific
GC /gc/doc/services GC Services Documentation Release specific
JTS /jts/doc/services JTS Services Documentation Release specific
QM /qm/doc/services QM Services Documentation (override this link with our own servers root) Release specific
RM /rm/doc/services RM Services Documentation Release specific

The following table contains key concepts you should become familiar with when working with ELM and OSLC based applications' APIs.

Component Key links Additional Details Last Updated
Cheat Sheet OSLC and REST API "cheat sheet" External Blog March 12, 2014
Eclipse Eclipse Lyo Eclipse Lyo is an improved Java framework with sample libraries and reference implementations for creating OSLC integrations June 22, 2023
Guide Guide for writing OSLC integrations OSLC application development guide  
OSLC OSLC GitHub repository GitRepo Ongoing
OSLC 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
Specification ELM Root Services Specification Key details document to understand API discovery process May 25, 2011
Workshop OSLC Workshop Covers CM and RM 2.0 specifications, Build basis 3.0-6.0 April 1, 2016

Jazz Foundation

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

Component Key links Additional Details Last Updated
Authentication Authentication of a native client with a Jazz-based application Details on authentication techniques across all APIs. June 11, 2018
Foundation SDK Documentation Build basis 4.x August 29, 2012
Foundation SDK Download Download to match your server Ongiong
Jazz Rest Services Jazz REST Services home Landing apge for key services details September 26, 2009
Process API Jazz Foundation Process API Build basis 4.0.3 December 15, 2023
Readiness API Documentation Build basis: 7.0.2 September 30, 2021
Rest API JTS Scenarios This document provides a number of scenario based examples of common uses of the API.  
User Profile Fetch User Profile NEW API Jauary 9, 2024

Global Configuration Management

GCM is a provider of global configurations as defined by the OSLC Configuration Management specification; EWM SCM, DOORS Next, and ETM 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.

Component Key links Additional Details Last Updated
Client Extention GCM Client Extension API    
OSLC Configuration Management Specification Specifications page Release 1.0 GCM Specifications July 23, 2023
Rest API Global Configuration Management Scenarios This document provides a number of scenario based examples of common uses of the API.  

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.

Component Key links Additional Details Last Updated
ReqIF API ReqIF API v1.0 New for 6.0.6.1 October 31, 2019
Client API Extension API Documentation   February 13, 2024
DNG Change Set Contents API Overview This document will provide scenario based examples of common uses of the API. 02-15-2024
Extension Examples Version 7.0.3   February 13, 2024
Module API Documentation   December 5, 2017
OSLC Article Using OSLC capabilities in the RM application Describes OSLC January 17, 2013
Reportable Rest API DN Reportable REST API - v6.0 or higher No significant changes for 7.X March 17, 2023
Reportable Rest API RRC Reportable REST API - v4.0.x thru v5.0.2 No longer supported August 6, 2018
Rest API DN Scenarios This document will provide scenario based examples of common uses of the API.  
RM Service Provider RM as an OSLC service provider Documentation in IBM Docs Release Dependent
Server API Documentation Supporting version 6.X and newer February 13, 2024
Video Tutorial Extending requirements functionality Demo from DN 4.0.5 March 09, 2017

Engineering Workflow Management (EWM / Formerly RTC)

Component Key links Additional Details Last Updated
WorkItem (Resource Oriented) 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 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
Blog post 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
Configuration 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
Java 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 Programmatic WorkItem Creation Introductory article on creating new workitems in EWM with Sample source code (RTC 1.x/2.x) June 6, 2009
Java Programmatic Defect Creation Introductory article on creating a linked defect from a work item (RTC 3.x) December 23, 2011
Java Plain Java APIís Article Build basis RTC 4.0.1 January 30, 2013
Java SDK Plain Java APIs Article for RTC 4.0.1 January 20, 2013
OSLC Consuming EWM OSLC Change Management V2 Services Introductory article on using EWM via OSLC July 10, 2012
OSLC Consuming EWMís OSLC Change Management V2 Services Build basis RTC 4.0 July 10, 2012
OSLC Automation OSLC Prototype Prototype of services automation API June 10, 2010
OSLC Work Items Service provider for OSLC 2.0 CM Specification Build basis RTC 3.0.1 May 24, 2018
OSLC - Enumerations API Changes for Enumerations 6.0.1: OSLC January 5, 2017
Reportable API Documentation Build basis RTC 3.0.1 August 4, 2015
Reportable API Forum Question/Answer How to consume Reportable REST API programmatically using Java November 18, 2015
SDK Document 7.0.3 Release October 26, 2023
SDK Extension Points and Operation IDís Build basis RTC 3.0.1.2 September 9th, 2019
SDK Creating Custom Operation Advisors Build basis RTC 2.0.0.2 August 25, 2010
Workshop Extensions Workshop EWM Extentions Workshop material May 7, 2021

Rhapsody Model Manager

Component Key links Additional Details Last Updated
Reportable API 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

Engineering Test Management (ETM / Formerly RQM)

Component Key links Additional Details Last Updated
OSLC QM V2 API Supported OSLC QM V2 API as supported by ETM August 10, 2023
Reportable API Documentation The ETM Reportable Rest API provides full CRUD capabilities October 23, 2023
Rest API QM Scenarios This document will provide scenario based examples of common uses of the API.  
Test Automation Adapter Documentation Build basis 7.0 May 27, 2020

Reporting

Component Key links Additional Details Last Updated
Article 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 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
Reportable API EWM Documetation EWM Reportable Rest API August 4, 2015
Reportable API ETM Documenation ETM Reportable Rest API October 3, 2023
Reportable API DN Documentation DN Reportable Rest API March 17, 2023
REST API Rest API Pub Document Builder REST API page February 19, 2024

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.

Related topics: Deployment web home

External links:

Additional contributors: Ralph Schoon, ToddDunnavant
Edit | Attach | Printable | Raw View | Backlinks: Web, All Webs | History: r10 < r9 < r8 < r7 < r6 | More topic actions
 
This site is powered by the TWiki collaboration platformCopyright © 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.