Edit
Attach
P
rintable
r19 - 2019-04-09 - 10:02:36 -
RosaNaranjo
You are here:
TWiki
>
Deployment Web
>
DeploymentIntegrating
>
CLMProductAPILanding
<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%"> ---+!! API Landing page <img src="https://jazz.net/wiki/pub/Deployment/WebPreferences/uc.png" alt="uc.png" width="50" height="50" align="right"> %DKGRAY% Authors: Main.RosaNaranjo, Main.JimRuehlin<br> Build basis: 6.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> This is a landing page for the various API wiki pages that exist on the Jazz.net development wiki as well as a central collective page of the known APIs that are available for integrating programmatically with our CE/CLM products. It serves as a convenience for accessing API information about CE/CLM products and is not guaranteed to have up-to-the-minute information. See the official API specifications for each CE/CLM component for complete information. Please see the [[https://www-01.ibm.com/support/docview.wss?uid=swg21986683][IBM Support Statement for CLM APIs]]. APIs are supported differently than CLM products. ---++ General OSLC and CLM API information [[https://jazz.net/library/article/635][OSLC Workshop]] [[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"]] [[https://github.com/OSLC][OSLC GitHub repository]] [[https://www.eclipse.org/lyo/][Eclipse Lyo]] - Java framework with sample libraries and reference implementations for OSLC [[https://github.com/OSLC/iotp-adaptor][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. [[https://jazz.net/wiki/bin/view/Main/JazzRESTServicesMain][Jazz REST Services home]] [[https://jazz.net/wiki/bin/view/Main/DraftTeamProcessRestApi][Jazz Foundation Process API]] [[https://jazz.net/wiki/bin/view/Main/JAFSdk][JAF SDK Main Page]] [[https://jazz.net/downloads/jazz-foundation/][Jazz Foundation SDK download page]] [[https://jazz.net/wiki/bin/view/Main/NativeClientAuthentication][Authentication of a native client with a Jazz-based application]] ---+++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. [[https://tools.oasis-open.org/version-control/browse/wsvn/oslc-core/trunk/specs/config/oslc-config-mgt.html][OSLC draft specification for Configuration Management]] - 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. [[https://jazz.net/gc/doc/scenarios][Global Configuration Management REST API]] - Documents extensions beyond the OSLC specification for the current release. The same release-specific documentation of these REST APIs can be found in your local CLM installation at https://[server]:[port]/gc/doc/scenarios. [[https://jazz.net/wiki/bin/view/Main/GcmExtensionApi][GCM Client Extension API]] ---++ 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 [[https://jazz.net/jazz/resource/itemName/com.ibm.team.workitem.WorkItem/384433][RM Enhancement 384433]]. [[https://jazz.net/wiki/bin/view/Main/DNGServerAPI][DNG Server API Documentation]] [[https://jazz.net/wiki/bin/view/Main/RMExtensionsMain][DNG Client Extension API]] [[https://jazz.net/wiki/bin/view/Main/DNGModuleAPI][DNG Module API]] [[https://jazz.net/wiki/bin/view/Main/DNGReportableRestAPI][DNG Reportable REST API - v6.0 or higher]] [[https://jazz.net/wiki/bin/view/Main/RRCReportableRestAPI][RRC Reportable REST API - v4.0.x thru v5.0.2]] [[https://jazz.net/library/article/87230][Extending requirements functionality (video)]] [[https://jazz.net/wiki/bin/view/Main/RMExtensionsExamples605][RM Extensions Examples version 6.0.5]] <img src="https://jazz.net/wiki/pub/Deployment/WebPreferences/new.png" width="25" height="25">[[https://jazz.net/wiki/bin/view/Main/DNGReqIF][ReqIF API v1.0]] New for 6.0.6.1 ---++ Rational Team Concert [[https://rsjazz.wordpress.com/2013/03/14/what-apis-are-available-for-rtc-and-what-can-you-extend/][What APIs are available for RTC and what can you extend?]] [[https://jazz.net/wiki/bin/view/Main/RtcSdk20][RTC SDK]] [[CLMOSLCAPIChangesFor601][6.0.1: OSLC API Changes for Enumerations ]] [[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://jazz.net/library/article/1229][RTC Plain Java APIs]] [[https://jazz.net/library/article/1001][Consuming Rational Team Concerts OSLC Change Management V2 Services]] ---++ Rational Quality Manager [[https://jazz.net/wiki/bin/view/Main/RqmApi][RQM Reportable REST API ]] [[https://jazz.net/wiki/bin/view/Main/RqmOslcQmV2Api][OSLC QM V2 API]] ---++ Reporting [[https://jazz.net/library/article/91481][A look inside LQE and Report Builder]] [[https://jazz.net/library/article/91450][Integrating external data sources with LQE and Report Builder]] [[https://jazz.net/wiki/bin/view/Main/ReportsRESTAPI][RTC Reportable REST API]] [[https://jazz.net/wiki/bin/view/Main/RqmApi][RQM Reportable REST API]] [[https://jazz.net/wiki/bin/view/Main/DNGReportableRestAPI][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 [[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 APIs 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]] ---+++++!! Additional contributors: Main.ThomasPoulin <sticky></div></sticky>
Edit
|
Attach
|
P
rintable
|
V
iew topic
|
Backlinks:
We
b
,
A
l
l Webs
|
H
istory
:
r46
|
r21
<
r20
<
r19
<
r18
|
More topic actions...
Deployment
Deployment web
Planning and design
Installing and upgrading
Migrating and evolving
Integrating
Administering
Monitoring
Troubleshooting
Community information and contribution guidelines
Create new topic
Topic list
Search
Advanced search
Notify
RSS
Atom
Changes
Statistics
Web preferences
NOTE: Please use the Sandbox web for testing
Status icon key:
To do
Under construction
New
Updated
Constant change
None - stable page
Smaller versions of status icons for inline text:
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
.