Inspired by Stephane Leroy Cheat Sheet about RQM Resources I will present my findings about RTC REST APIs. This is “work in progress” I will extend the Post as needed.
Every time you request a resource don’t forget to include the following headers.
The API returns 20 items per page by default, and currently the maximum results per page is 300. Partial Resources If you only need a small portion of a resource (such as a first and last name), you can specify fields by appending fields=, to the URI, separating each field with a comma. The next article from the desktop automation series will be dedicated to WinAppDriver. WinAppDriver is a service to support Selenium-like UI Test Automation on Windows Applications. This service supports testing Universal Windows Platform (UWP), Windows Forms (WinForms), Windows Presentation Foundation (WPF), and Classic Windows (Win32) apps on Windows 10 PCs. The cheat sheet is ordered chronologically. Its issue-pattern tables suggest when to apply which pattern. 1 Warning: The cheat sheet is a gross simplification of a set of complex design considerations; API design is a wicked problem.The pattern texts discuss forces and consequences of solutions in depth.
| Name | Value |
|---|---|
| OSLC-Core-Version | 2.0 |
| Accept | application/xml |
| Content-Type | application/rdf+xml |
RTC REST API
Create the URL with the CLM Server name and the URL Snippet from the table below like https://jazzserver.ibm.com:9443/cm/process/project-areas
| ACTION | URL SNIPPET |
|---|---|
| Show all Services | ccm/service > 302 Redirect to ccm/service/com.ibm.team.repository.service.ITeamServerStatusContentService/ |
| Service Provider Catalog | ccm/oslc/workitems/catalog |
DNG REST API
Create the URL with the CLM Server name and the URL Snippet from the table below like https://jazzserver.ibm.com:9443/cm/process/project-areas
| ACTION | URL SNIPPET |
|---|---|
| Show all Services | rm/service > 302 Redirect to rm/service/com.ibm.team.repository.service.ITeamServerStatusContentService/ |
Api Cheat Sheet
RTC Process REST API (link)
Create the URL with the CLM Server name and the URL Snippet from the table below like https://jazzserver.ibm.com:9443/cm/process/project-areas
| Action | URL Snippet |
|---|---|
| Get RTC Project Areas | ccm/process/project-areas |
| Service Provider Links collection | ccm/process/project-areas/_qZ1dsu9YEeOb7eLwSED0KA/links |
| Service Provider Catalog | ccm/oslc/workitems/catalog |
DNG Process REST API (no documentation found, put it seems similar to RTC)
| Action | URL Snippet |
|---|---|
| Get DNG Project Areas | rm/process/project-areas |
| Service Provider Links collection | rm/process/project-areas/_7jWhMl3qEeSt–_ZBwtxhQ/links |
RTC Service SOAP API
Rest Api Cheat Sheet
Create the URL with the CLM Server name and the URL Snippet from the table below like https://jazzserver.ibm.com:9443/cm/process/project-areas
| Action | URL Snippet |
|---|---|
| Get al RTC Project Areas | ccm/service/com.ibm.team.process.internal.service.web.IProcessWebUIService/allProjectAreas?hideArchivedProjects=true |
| Get Queries of a certain PA | ccm/service/com.ibm.team.workitem.common.internal.rest.IQueryRestService/scopedQueries?scope=3&includeCount=false&includeParentScopes=true&projectAreaItemId=_0H5NsGmGEeSmHamBorgNJw&suppressCrossRepoQueries=false |
Api 14c Cheat Sheet
RQM REST API (Reporting API)
To my surprise is the RQM Reporting API “CRUD” able.
Apa Cheat Sheet 2020
Details here.