This post is from the CollabNet VersionOne blog and has not been updated since the original publish date.
Scripting TeamForge Connector Server (CCF 2.0) REST API for fun and profit
One major feedback we received on CCF 1.x was that our customers really liked its bidirectional artifact synching functionality to HP ALM/Quality and Scrumworks Pro but did not like the fact that they could only control its behavior from a locally installed Eclipse client.
As part of CollabNet’s Connect Initiative, we started over with TeamForge Connector Server 2.0 (aka CCF 2.0) and exposed all its functionality over a REST API. Now, there is no need a locally running Eclipse any more and all functionality can be accessed remotely. In fact, all our remote clients (Windows Desktop and Eclipse Desktop) make use of this API.
While our clients already expose a lot of CCF 2.0 features, the REST API can also be used to remotely control the synchronization server with your own tools. For example, you could automatically create an SWP project mapping whenever a new TF project has been created, you could display in TF web UI whether the corresponding defect in HP ALM is already locked/already created or you could come up with your own reporting tool on failed shipments. REST is completely platform neutral, so you can use the programming language of your choice.
This blog post should kickoff a community discussion on our REST API. We will look at your comments to find out in which areas you like to see more examples, where you like to see additonal API methods and also give you a platform to share your custom CCF client code samples.
As a start, we like to point you to a great blog post that gives a short TeamForge Connector REST tutorial based on a Python program that can be used to monitor a customizable list of TF trackers for failed shipments. This program was inspired by a feature request on our CCF mailing list.
So without further ado, please have a look at our REST API tutorial and provide us feedback on what we should blog next.