The test-project and git resources refers to Git projects.
Use the test-project resource to access Git project information using simple query or by using advance filters, get the latest test suite collections in a Git project, or delete a specific Git project.
Use the test resource to create a new Git project, update an existing one.
Request input
Refer to the dependency issue when adding additional query parameters in your HTTP request: Find test project ID
Methods
To learn more about Git projects, see the following documentation: Organizing tests.
Response body sample
{
"id": 517169,
"name": "ci-samples",
"description": "",
"projectId": 934901,
"createdAt": "2023-01-05T07:05:21.399+0000",
"type": "GIT",
"gitRepository": {
"id": 316592,
"testProjectId": 517169,
"repository": "https://gitlab.com/john.doe/ci-samples",
"branch": "refs/heads/update-gitlab-sample",
"username": "[email protected]",
"password": "",
"createdAt": "2023-01-05T07:05:21.399+0000",
"vcsType": "GITLAB",
"shouldMergeTestResultsForNewScriptRepo": false
},
"testSuiteCollections": [
{
"id": 354022,
"name": "Test Suites/Advanced/TS_RegressionTestCollectionParallel",
"urlId": "354022-Test Suites/Advanced/TS_RegressionTestCollectionParallel"
},
{
"id": 354023,
"name": "Test Suites/TS_RegressionTestCollection",
"urlId": "354023-Test Suites/TS_RegressionTestCollection"
}
],
"dirty": false
}
Refer to the following table about the response body parameters:
| Property | Type | Description |
|---|---|---|
id | integer | The unique identifier of the test project. |
name | string | The test project name. |
description | string | The test project description. |
projectId | integer | The unique identifier of the associated Katalon project. |
createdAt | date-time | The date and time when the test project was configured. |
type | string | The script repository type: GIT (for Git-based) or KS (for non-Git). |
gitRepository | git repository object | The object that describes the Git repository attached to the test project. |
| testSuiteCollections | array of test suite collection objects | The test suite collections that the test project stores. |