Find the ObjectID (OID) of Projects, Workspaces, Timeboxes

Document ID : KB000047910
Last Modified Date : 14/02/2018
Show Technical Document Details

Issue

There will be some instances while creating reports that in order to properly scope which work items are being reported, that the Project and Workspace OID (ObjectID) is required for configuration. ?This will ensure that results displayed only pertain to what values are configured. ?

Situations where you may require the OID (ObjectID) include but are not limited to:
  • Developers creating custom integrations or apps with AppSDK2 and or WSAPI (Web Services API). See Developer Portal for available API Toolkits.
  • Developers and Users who develop or display CA Agile Central apps or StandardReports externally outside of CA Agile Central. See relevant AppSDK2 guides Developing Apps Externally, Embedding Apps,? StandardReports

Resolution

Method 1 - Determine Workspace & Project OIDs from URL (Any User Permission)


Project:

User-added image

The URL of a Work Item contains the OID (Object ID) of the Project where the given Work Item is contained.?
?
  1. Navigate to the Detail Page of the CA Agile Central Work Item (User Stories, Tasks, Portfolio Items, Test Cases, Test Case Results, Defects, and Defect Suites)
?
In the above example, "98765432" is the Project OID, while "12345678901" is the OID of the User Story being accessed. Note that the trailing 'd' is not part of the ObjectID. Letters 'd' or 'u' indicate current selection to scope down or up in the project hierarchy. Fore more information see this article:
What is the significance of a trailing d after an ObjectID in the URL?
Workspace:

The Workspace OID may be copied from the URL when performing a WSAPI (Web Services API) query. ?This can be found with any query, though I will give an example below.
  1. Navigate to https://rally1.rallydev.com/slm/doc/webservice/?(Requires login to CA Agile Central)
  2. From the left-hand navigation, click Artifact
  3. Click the Query button and inspect the URL in the resulting window
? ??User-added image? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ??
User-added image? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ??
https://rally1.rallydev.com/slm/webservice/v2.0/artifact?workspace=https://rally1.rallydev.com/slm/webservice/v2.0/workspace/12345678&query=&start=1&pagesize=20
In the above example, "12345678" is the Workspace OID
?

Method 2 - Determine Workspace & Project OIDs from URL (Subscription or Workspace Administrator)

Both the Workspace and Project OIDs can be copied from the URL of their direct Detail Pages. ?Only administrators however have access to the Workspace and Project detail pages.
  1. Logged in as an administrator click Setup at the top-right (hammer and wrench icon) ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ? ?
  2. Click the Workspaces & Projects tab
  3. Click the Name of either a Workspace (top-level in tree) or Project to view the Detail Page
?
User-added image

User-added image
In the first above example?"/workspace/12345678901" is the Workspace OID (From Workspace Detail Page)
In the second above example "/project/09876543210" is the Project OID (From Project Detail Page)
?
?
Method 3 - Use Custom Page and the Custom HTML App

A custom HTML app may used to determine Project and Workspace OIDs, and will change dynamically depending on what Workspace/Project you have selected form the picker.
  1. Create a Custom Page
  2. From the Custom Page, select the gear icon and choose?Add an App...
?User-added image
  1. From the left-hand menu, choose Custom HTML and click Add This App
  2. Add the following code to the HTML portion of the Custom HTML settings which will automatically display and click Save
<html>
Current Workspace ID: __WORKSPACE_OID__
Current Project ID: __PROJECT_OID__
Current User ID:  __USER_OID__
Curent User Name: __USER_NAME__
</html>
User-added image
?
?
?
Current Workspace ID: 11111 Current Project ID: 22222 Current User ID: 33333 Curent User Name: user@co.com

The above example is similar to the result in the app displaying the OIDs of the Workspace/Project that you are scoped to. ?Click here for more information on Workspace/Project scoping.

Iteration and Releases:

It is easy to determine ObjectID of Iteration and Release from the URL. The highlighted string below is ObjectID of Iteration:

User-added image