Skip to main content
System StatusContact Support Agility Community

Exercise 2: Find a Scope (Project) OID Token in the UI


This tutorial will help you associate a project (Scope) that you would normally see in the VersionOne UI with data from the API.


  • Access to a VersionOne 17.0 instance or newer.

  • Knowledge of the VersionOne APIConsole 

What you'll learn

  • How to find the OID Token of a Scope within the VersionOne UI

  • How to use the numeric portion of an OID Token to get the default API representation of a Scope using the VersionOne Http Tool

Step 1: View the Projects page in VersionOne

To get started, navigate to the Projects page in our VersionOne example instance. Use the username admin and password admin when prompted.

You should see a page like this after authenticating:

Our goal is to query our VersionOne instance by asking questions about Scope 0. Scope is a system name for project. When we do our query, we will see the name of the project that is known in the system as Scope:0. Recall that in Excercise 1: Basic Use of the API Console, we did a basic query on the Scope 0. In this exercise, we will find the OID to a specific project name, and then query it the same way we did in Exercise 1.

Follow these steps to get the previous page into full screen mode:

  1. Click VersionOne VersionOne REST API 101 

  2. Click on the button indicated by the arrow.

Step 2: Isolate the OID in the URL

  1. Copy the text after the = sign in the highlighted oidToken query string parameter to your clipboard, but note this: You may see oidToken=Scope%3A1005 instead of oidToken=Scope:1005. This is because of URL encoding. The %3A is the encoded value for the : character.

  2. Paste this value (should be Scope:1005 or Scope%3A1005) into a text editor and then:
    • Replace the : (or %3A characters) with a single / character, producing Scope/1005

    • Finally, prefix the whole thing with another single / character, producing /Scope/1005

Still with us? Keep your /Scope/1005 text handy, and head to Step 3!

Step 3: Examine your query and execute

  1. Now that you have learned how to decompose the URL and extract the OID, modify your URL so that your API Console looks like this.

  2. Click Send.

Voila! Here is the output of your query.


In this exercise, you learned how to:

  • Decompose a URL from the Project view in the UI.

  • Use the results of the URL decomposition to query the project in Rest.