Getting started with Rally REST webservice API

Jen picture Jen · Nov 12, 2012 · Viewed 29.8k times · Source

Was after some help on getting started with calling the Rally REST webservice from a .NET MVC webclient.

I've been given the web service info here:

https://rally1.rallydev.com/slm/doc/webservice/

So I can see that I can use a URL to access information from Rally - Similar to:

https://rally1.rallydev.com/slm/webservice/1.39/task?query=((Owner.Name
= [email protected]) and (State != Completed))&order=Rank&fetch=true&stylesheet=/slm/doc/webservice/browser.xsl

However what I'm not clear on is how to authenticate before making my request?

I'm new to REST web services (have done the SOAP/WSDL awhile back) - so it doesn't seem like with REST you're supposed to add a reference to something to get client classes created? Is this correct? That you just create a HTTPRequest using a URI - and make the call, getting back a HTTPResponse (which I can hopefully do something with).

A lot of examples seem to have specific service/api classes that they're calling methods on or accessing properties - so I'm not sure if that's because they're using SOAP rather than REST - or that they created them themselves.

Maybe I'm looking at the wrong documentation as it seems assumed you know how to be authenticated. Or I'm missing a reference?

Answer

Kyle Morse picture Kyle Morse · Nov 12, 2012

The main web service docs you found are great for exploring the objects and fields in the data model. Since you're using .NET you'll probably want to check out our .NET REST toolkit:

http://developer.rallydev.com/help/rest-api-net

You'll find examples to get you started with the basic CRUD+Query operations it provides. Authentication is done for you. There are a decent number of questions and code examples pertaining to the toolkit right here on stackoverflow as well if you get stuck.