It's all about the answers!

Ask a question

Are there any API docs?


Eric Benzacar (41512) | asked Aug 27 '15, 2:35 p.m.
 I'm trying to use the JazzRTC Java API but I'm having a lot of difficulty understanding how to use it.  I have found the Javadocs already, and although javadocs are great from a pure technical perspective, they do not explain how things work together from a general perspective.

I found the following blog on the Jazz site Rational Team Concert Plain Java API's which is a good start, but I'm still struggling to understand basic principals.  For example, which classes I need to use to checkin/checkout files from a workspace.  Which classes I need to deliver content to a stream.  Etc.

Is there any additional documentation apart from the javadocs to better understand how Jazz/the API works?

2 answers



permanent link
Ralph Schoon (58.7k23642) | answered Aug 27 '15, 3:46 p.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER
There is JavaDoc for download, however, I don't think it is very useful.
Start here: Setting up Rational Team Concert for API Development and Understanding and Using the RTC Java Client API and search that blog for more info. Also What API's are Available for RTC and What Can You Extend? and https://rsjazz.wordpress.com/interesting-links/ could be useful.  

Comments
Eric Benzacar commented Aug 27 '15, 4:55 p.m.

 Thanks.  I had found a lot of those sites already.  At the moment, I'm specifically looking for docs relating to creating files/folders via the API and can only find blogs (mostly from non-official Jazz sites) which use parts of the API which are undocumented (ex: IFileItem, IFileContent,Manager, IFile*, etc).


So I'm wondering where the knowledge comes from?  There are no API docs for these classes, and I read somewhere that no javadocs means the classes aren't part of the official API (useable, but can easily change from one version to another).

So how/where do I find out how to manage files & folders?


Ralph Schoon commented Aug 27 '15, 5:32 p.m.
FORUM ADMINISTRATOR / FORUM MODERATOR / JAZZ DEVELOPER

There is few official documentation available besides the JavaDoc. There is however the SDK and you can basically see the classes and the documentation if you followed  Setting up Rational Team Concert for API Development and Understanding and Using the RTC Java Client API. Even, if available for internal classes.

We who share looked into the SDK how RTC uses this itself. and some like Evan are developers. You will not find other documentation. So go with the posts e.g. https://rsjazz.wordpress.com/2013/10/15/extracting-an-archive-into-jazz-scm-using-the-plain-java-client-libraries/ or http://thescmlounge.blogspot.de/2013/08/getting-your-stuff-using-rtc-sdk-to-zip.html .





permanent link
sam detweiler (12.4k6182201) | answered Aug 27 '15, 5:53 p.m.
edited Aug 27 '15, 5:58 p.m.
the structure of the API for source code mgmt is a lot more complex than the workitem api.

Unless you REALLY REALLY need to use the API, I would suggest using the commandline to build scripts.

additionally you might be able to get some concepts here
https://jazz.net/library/LearnItem.jsp?href=content/docs/client-tour/using-scm.html

note that like the rest of the system, scm is object oriented, so it takes many classes generally to construct an operating piece of logic

Comments
Eric Benzacar commented Aug 27 '15, 9:51 p.m.

 Using the commandline is not an option.  I REALLY, REALLY, need to use the API to embed the solution into another application.


Your answer


Register or to post your answer.