API ReferenceDocumentationCommunityAcademyPlatform
API Reference

Find ID variables for API calls

Katalon TestOps uses ID values to identify resources, such as the name of your Organization, Project, test suites, and more. To access a resource through an API call, specify the ID value in the request URL.

📘

Find the ID of TestOps resources

For most of TestOps resources, you can find the ID values by logging into Katalon TestOps and accessing the corresponding user interfaces of the resources and checking the URL.

Find project ID

To find your project ID, log in to TestOps with your credentials. Select your desired project. You can see the project ID in the URL.

Find test project ID

A Katalon project can have multiple script repositories to store different types of tests. Script repositories are fully integrated with Git for version control and synchronization between different modules in the Katalon Platform.

See: Configure a Git repository in TestOps.

🚧

Dependency issues

TestOps used the test project object as a wrapper for both Git-based and non-Git (zip) script repositories. As Git integration is now mandatory for every Katalon project, TestOps no longer supports non-Git script repositories. To access the configured Git script repository of your project, you can query the test project object and find the child git repository object.

To find the ID of a test project, in TestOps, go to your Katalon project > Configurations > Script Repositories, and select the desired script configuration. The test project ID is displayed in the URL.

Find test case ID

To perform the request methods for the test case endpoint, you need to provide a test case ID

To find the test case ID in TestOps, go to your Project > Test Management > Test Cases, and select the desired test case.

You can see the ID in the browser's address bar as shown below:

In the URL https://testops.katalon.io/team/{teamid}/project/{projectid}/test-design/test-cases/2099058-tc1)verify-successful-login, the test case ID is 2099058.

Find test suite ID

To find the ID of a test suite in a test run, go to your project > Test Management > Test Suites, and select the desired test suite.

You can see the ID in the browser's address bar as shown below:

In the URL https://testops.katalon.io/team/{teamid}/project/{projectid}/test-design/test-suites/1120266-mobile-testing-native-app, the test suite ID is 1120266.

Find test run order ID

TestOps uses the Project ID and order value to identify a test run in API requests. To retrieve your Project ID and order value, in TestOps, go to your Project > Reports > Test Runs, and select the desired test run.

You can see the Project ID and order value in the browser's address bar as shown below:

In the URL https://testops.katalon.io/team/{teamid}/project/255858/executions/865, the Project ID and test run order are 255858 and 865, respectively.

Find smart scheduler ID

Every smart scheduler object contains a unique run configuration object storing execution configuration.

To identify a smart scheduler object, TestOps uses the ID of the child run configuration object. You can use this ID in API requests to query information about the corresponding scheduled test execution.

To find the ID of a smart scheduler object (or the ID of the child run configuration) in TestOps, go to your Project > Test Execution > Test Run List, and select the scheduled test execution.

You can see the ID in the browser's address bar as shown below:

2378

Find smart scheduler ID

For example, with the URL https://testops.katalon.io/team/{teamid}/project/{projectid}/grid/plan/197932/job, the smart scheduler ID is 197932.

Find run configuration ID

A run configuration object shares the same ID as its parent smart scheduler object.

To find run configuration ID, see Find smart scheduler ID.

Find test result ID

A test result belongs to only one test run. See: Test run.

TestOps uses the test result ID to identify a test result object. To find the ID of a test result in a test run, follow these steps:

  1. In TestOps, go to your project > Reports > Test Runs, and select the desired test run.
  2. Switch to the Test Results tab. You can see a list of test result IDs of test cases associated with the test run.

Find release ID

To find the ID of a release object, in TestOps, go to your Project > Planning > Releases, and select the desired release.

You can see the ID in the browser's address bar as shown below:

IN the URL https://testops.katalon.io/team/{teamid}/project/{projectid}/releases/299407, the release ID is 299407.

Find build ID

A release can have several builds, to find the ID of a specific build of a release:

  1. In TestOps, go to your Project > Planning > Releases and select a release.
  2. In the Builds section, select the desired build.

You can see the build ID in the browser's address bar as shown below:

In the URL https://testops.katalon.io/team/{teamid}/project/{projectid}/releases/299407/builds/78869, the build ID is 78869.