Create a test suite

Request

This request uses the POST method, which is used to create a new test suite within a specified test project. The request includes authentication, headers, and data necessary for the server to create the test suite with the specified name and associated test cases.

For basic authorization, replace this with your actual username and password (or API key) in the header request in the username:password or username:api_key format. Your user creds are combined to form a Base64 encoded string.

The request data is provided as a JSON object in the --data option. It includes the following fields:

testProject: An object containing information about the test project to which the test suite will be associated.
name: The name or title of the new test suite.
testCases: An array of test case object/s to include in the new test suite. Per object, you need to provide the test case specified with its ID, the name of the test case, and path (for example, test-design/test-suites).

Response

The response is in JSON. This API response would likely contain information about the newly created test suite, including its ID and other details.

See the following example:

{
  "id": 0,
  "name": "string",
  "path": "string",
  "project": {
    "id": 0,
    "name": "string",
    "teamId": 0,
    "status": "ARCHIVE"
  },
  "alias": "string",
  "updatedAt": "2023-09-11T04:11:49.274Z",
  "testProject": {
    "id": 0,
    "name": "string",
    "description": "string",
    "defaultTestProject": true,
    "uploadFileId": 0,
    "projectId": 0,
    "teamId": 0,
    "createdAt": "2023-09-11T04:11:49.274Z",
    "uploadFileName": "string",
    "type": "KS",
    "dirty": true
  },
  "createdAt": "2023-09-11T04:11:49.274Z",
  "type": "KATALON_STUDIO",
  "testFolder": {
    "id": 0,
    "name": "string",
    "rawPath": "string",
    "testProject": {
      "id": 0,
      "name": "string",
      "description": "string",
      "defaultTestProject": true,
      "uploadFileId": 0,
      "projectId": 0,
      "teamId": 0,
      "createdAt": "2023-09-11T04:11:49.274Z",
      "uploadFileName": "string",
      "type": "KS",
      "dirty": true
    },
    "treePath": "string",
    "parentId": 0
  },
  "urlId": "string"
}

Refer to the following table about the response body parameters:

Property	Type	Description
`id`	`integer`	The unique identifier of the test suite.
`name`	`string`	The name of the test suite.
`path`	`string`	The file folder location of the test suite in TestOps.
`project`	`project` object	The `project` object associated with the test suite.
`alias`	`string`	The alias for the test class used in a test script.
`lastExecutionTestSuite`	`lastExecutionTestSuite` object	This object contains details of the latest execution of a test suite, including execution status, total tests executed, duration, execution ID, and start and end times.
`updatedAt`	`string`	The date and time when the test suite was last updated.
`createdAt`	`string`	The date and time when the test suite was created.
`testProject`	`test project` object	The `test project` object associated with the test suite.
`type`	`string`	Indicates the type of the entity.
`testFolder`	`test folder` object	The `test folder` object represents the test folder or directory.
`urlId`	`string`	The unique URL identifier of a test suite.

Try it!

Enter the required parameters below.
Select the language in Language.
Enter your user name or API credentials.
Review your API call and click Try it!