Rally Software

Expand all | Collapse all

WSAPI retrieve list of workspaces

Jump to Best Answer
  • 1.  WSAPI retrieve list of workspaces

    Posted 09-10-2014 10:47 AM
    I am unable to get a list of workspaces with WSAPI v2.0

    however, v1.29 works with the following query:
    https://rally1.rallydev.com/slm/webservice/1.29/subscription.js?fetch=Workspaces,Name,Projects&pretty=true


    I have tried walking:
    1. https://rally1.rallydev.com/slm/webservice/v2.0/subscription/
    2. https://rally1.rallydev.com/slm/webservice/v2.0/subscription/123456789
    3. https://rally1.rallydev.com/slm/webservice/v2.0/Subscription/123456789/Workspaces
    result:
      {
         QueryResult: {
        _rallyAPIMajor: "2",
        _rallyAPIMinor: "0",
        Errors: [ ],
        Warnings: [ ],
        TotalResultCount: 3,
        StartIndex: 1,
        PageSize: 20,
        Results: [ ]
         }
        }


    I have tried:


    https://rally1.rallydev.com/slm/webservice/v2.0/Subscription/123456789/Workspaces?fetch=true
    https://rally1.rallydev.com/slm/webservice/v2.0/Subscription/123456789/Workspaces?fetch=ObjectID

    All return just the basic QueryResult summary, and an empty QueryResult.Results.


    The following posts do not work:
    1. https://rallydev.force.com/answers#!/feedtype=SINGLE_ARTICLE_SEARCH_RESULT&id=kA014000000PK1U
    2. Rally Success Question: "How we can fetch all workspaces associated to a particular user using Rest API v2.0?"




    Please advise.


  • 2.  Re: WSAPI retrieve list of workspaces

    Posted 09-10-2014 11:25 AM
    Hi Lloyd,  did the answer posted in the question linked below help you? 

    Problems while fetching all the workspaces for a particular subscription


  • 3.  Re: WSAPI retrieve list of workspaces

    Posted 09-10-2014 11:33 AM
    Unforunately, no, it'll only show me the current workspace for which I'm logged in for on the frontend.

    https://rally1.rallydev.com/slm/webservice/v2.0/workspace?workspace=https://rally1.rallydev.com/slm/webservice/v2.0/workspace/123456789&query=&start=1&pagesize=20
    will only giev me back one result... not the three I am expecting.

    if I go:
    https://rally1.rallydev.com/slm/webservice/v2.0/workspace?query=&start=1&pagesize=20 also limited to one result.
    Reading somewhere else:
    https://rally1.rallydev.com/slm/webservice/v2.0/workspace?query=&start=2&pagesize=20  [NOTE the start position 2]
    will give me the basic QueryResult summary, and an empty QueryResult.Results.





  • 4.  Re: WSAPI retrieve list of workspaces

    Posted 09-10-2014 12:40 PM
    Hi Lloyd,
    sorry for the troubles.  I submitted a defect. If I use the endpoint with pagesize=200 exactly (after replacing the <Subscripton ObjectID> placeholder with actual sub OID) as shown in this article (https://rallydev.force.com/answers?id=kA014000000PK1U)

    https://rally1.rallydev.com/slm/webservice/v2.0/subscription/<Subscripton ObjectID>/workspaces?&pagesize=200&fetch=ObjectID

    it returns all workspace objects, but if I change pagesize to 20 or entirely omit it, it does not return workspace objects. You may see the outcome of my test in this short (a few seconds) video (http://screencast.com/t/xh6HuLueObms). I think it's a bug. If the TotalResultCount is 3 which is below the default pagesize of 20, I don't belive the pagesize parameter should matter, and using 200 does not seem like a workaround to me - it is possible that it worked for me only because of a specific position of workspaces in question within my collection of workspaces, which would be different in different subscirptions. (Note that 200 is max pagesize in WS API).


  • 5.  Re: WSAPI retrieve list of workspaces

    Posted 09-10-2014 05:32 PM
    Nick, nice to know you can reproduce it.

    Modifying your link, to my IDs... I cannot get that work.

    tried:
    still don't work for me... they always return back TotalResultCount:3, Results:[].


    Is there an ETA on it being fixed, and released on rally1?


  • 6.  Re: WSAPI retrieve list of workspaces
    Best Answer

    Posted 10-01-2014 01:01 PM
    Hi Lloyd,
    A fix was released and defect closed a few days ago. It was linked to an older defect when TotalResultsCount did not match the actual number of workspace or projects objects returned when "subscription/workspaces" or "workspace/projects" endpoints were used under certain permissions scenarios (e.g. there were closed projects to which a user never had access to).
    I verified that I no longer can replicate this problem. Would you please test it too and let me know?Thank you.


  • 7.  Re: WSAPI retrieve list of workspaces

    Posted 10-01-2014 02:03 PM
    Yes, confirmed that is now works.