Rally Software

  • 1.  Developer Documentation Access

    Posted Dec 18, 2013 03:26 PM
    Hello,

    We are trying to get some additional documentation in using the RallyDev REST and Java API. It appears we need an account here https://rally1.rallydev.com/slm/login.op.

    How do I and other DevOps Systems team members go about getting an account to login here.

    Thanks,


  • 2.  Re: Developer Documentation Access
    Best Answer

    Posted Dec 18, 2013 03:31 PM
    Thank you for contacting Rally.

    Java REST toolkit documentation is here on github (https://github.com/RallyTools/RallyRestToolkitForJava).


    Rally Developer Portal (https://help.rallydev.com/for-developers) points to the same RallyRestToolkitForJava github repository.

    You do not need Rally credentials to access either the repository  or the portal.

    If you are following a link to Web Services API documentation from one of those locations you need Rally credentials.

    If you right click on the link pointing to WS API document, and use Copy Link Address menu option you will see that it is pointing to:
    https://rally1.rallydev.com/slm/doc/webservice/

    But if you left click on that link while you are not logged in to Rally you will be redirected to the login page:
    https://rally1.rallydev.com/slm/login.op

    After you enter your Rally credentials and successfully logged in to Rally you may go to
    https://rally1.rallydev.com/slm/doc/webservice/

    WS API documentation is specific to your data. For example, if you have a custom field in a workspace, WS API documentation will show it with c_ prepended to the attribute name.  You may query directly in the WS API document. The results are specific to your data. Your Rally username and password are needed to access WS API documentation. There are no separate login credentials to access WS API documentation but you must be logged in to Rally in order to see it.

    In on-premises environment, the URL to the Web Serivices API documentation is unique to the organization and follows this format:
    https://<YOUR_RALLY_URL>/slm/doc/webservice/

    It still requires Rally credentials to access.