Rally Workspace and Project Object IDs retrieval without administrative rights
search cancel

Rally Workspace and Project Object IDs retrieval without administrative rights

book

Article ID: 47763

calendar_today

Updated On:

Products

Rally SaaS

Issue/Introduction

All Rally artifacts carry a unique number called the Object ID, also known as the OID of the artifact. This number is generally hidden behind the scenes, and allows the software to find an item in its exact location. When writing a webscript or custom application for Rally, these OIDs are needed to point to the correct Project or Workspace.

 

 



Resolution

 

If you are not an administrator, you can use the process below to query these values through web services:

 

1. Create a new Custom View.  The advantage of using a custom view like this is that you can always refer to it later as long as you do not delete this Custom View.

  • In your new Custom View, add a Tall Stretch section
  • In the Title of the section enter:  My Object IDs (or whatever name is preferred)
  • Click Add Widget and add a Custom HTML widget 
  • In the HTML Source field, paste the following code (also available in the Custom HTML Widget documentation)


      <head>
          <script 
      src="//unpkg.com/json-viewer-custom-element"></script>
        
      <script>
          // $RallyContext:Begin
             const $RallyContext = {
                   WidgetName: 'My Widget' 
          }
          // $RallyContext:End
        
          window.onload = () => {
     document.getElementById('json-viewer').setAttribute('value', 
     JSON.stringify($RallyContext));
          }
        </script>
     </head>
     <body>
        <h1>$RallyContext Context Browser:</h1>
        <json-viewer id='json-viewer' value="{}"></json-viewer>
      </body>

  • Click Save Configuration
  • Click Save Changes on the Custom View 
  • When completed, you will see the following.  Expand the nodes to get to the information you need:
     

The Global Scope item contains information about the currently selected scope.  

 

2.  Get the ObjectID of a current workspace using the Web Services API

  • Go to Web Services API documentation when you are already logged in to Rally in another tab of your browser
    • https://rally1.rallydev.com/#/wsapidoc
  • The top right of the page displays:
    • Subscription: <your subscriptions name> (ObjectID = <your sub oid>)
    • Workspace: <your workspace name> (ObjectID = <current workspace oid>)

Informational:  Here is the help page for the Rally WSAPI documentation:  https://techdocs.broadcom.com/us/en/ca-enterprise-software/valueops/rally/rally-help/reference/rally-web-services-api.html 

 

Powered by Wolken Software