Delete a test suite

Request

This request uses the DELETE method, which is used to delete a specific test suite from the specified resource.

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.

You need to provide the following required query parameters:

id: the alphanumeric ID of the test suite.

Response

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

Here's a structured template of an API response for a DELETE request:

{
  "id": 0,
  "name": "string",
  "path": "string",
  "project": {
    "id": 0,
    "name": "string",
    "teamId": 0,
    "status": "ARCHIVE"
  },
  "alias": "string",
  "lastExecutionTestSuite": {
    "status": "PASSED",
    "startTime": "2023-09-11T04:11:49.274Z",
    "endTime": "2023-09-11T04:11:49.274Z",
    "duration": 0,
    "elapsedDuration": 0,
    "totalTests": 0,
    "totalPassedTests": 0,
    "totalFailedTests": 0,
    "totalErrorTests": 0,
    "totalIncompleteTests": 0,
    "totalSkippedTests": 0,
    "totalDiffTests": 0,
    "totalDiffPassedTests": 0,
    "totalDiffFailedTests": 0,
    "totalDiffErrorTests": 0,
    "totalDiffIncompleteTests": 0,
    "id": 0,
    "execution": {
      "status": "PASSED",
      "startTime": "2023-09-11T04:11:49.274Z",
      "endTime": "2023-09-11T04:11:49.274Z",
      "duration": 0,
      "elapsedDuration": 0,
      "totalTests": 0,
      "totalPassedTests": 0,
      "totalFailedTests": 0,
      "totalErrorTests": 0,
      "totalIncompleteTests": 0,
      "totalSkippedTests": 0,
      "id": 0,
      "projectId": 0,
      "buildId": 0,
      "order": 0,
      "executionStage": "RUNNING",
      "hasComment": true,
      "sessionId": "string",
      "buildLabel": "string",
      "buildUrl": "string",
      "type": "KATALON",
      "useTestCloudTunnel": true
    },
    "testSuite": {
      "status": "PASSED",
      "startTime": "2023-09-11T04:11:49.274Z",
      "endTime": "2023-09-11T04:11:49.274Z",
      "duration": 0,
      "elapsedDuration": 0,
      "totalTests": 0,
      "totalPassedTests": 0,
      "totalFailedTests": 0,
      "totalErrorTests": 0,
      "totalIncompleteTests": 0,
      "totalSkippedTests": 0,
      "id": 0,
      "projectId": 0,
      "buildId": 0,
      "order": 0,
      "executionStage": "RUNNING",
      "hasComment": true,
      "sessionId": "string",
      "buildLabel": "string",
      "buildUrl": "string",
      "type": "KATALON",
      "useTestCloudTunnel": true
    },
    "platform": {
      "id": 0,
      "osName": "string",
      "osVersion": "string",
      "browserName": "string",
      "browserVersion": "string",
      "deviceName": "string",
      "appName": "string"
    },
    "executionId": 0,
    "profiles": [
      "string"
    ],
    "hasComment": true,
    "urlId": "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",
  "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.
`urlId`	`string`	The unique URL identifier of a test suite.

Try it!

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