Skip to content
developers
Open TestCollab

Bulk actions on test cases

POST/testcases/bulkAction

Bulk actions on test cases

Example

Section titled “Example”

Use resource IDs from your own project. Keep the API token in your server or CI environment.

example.ts
import { createConfiguration, TestCasesApi } from '@testcollab/sdk';


const config = createConfiguration(process.env.TESTCOLLAB_TOKEN!);
const api = new TestCasesApi(config);


const result = await api.testCaseBulkActions({
  "testCaseBulkActionPayload": {
    "actionType": "example",
    "project": 123,
    "testcaseIds": []
  }
});
console.log(result);

Request body

Section titled “Request body”
Field Type Required Description
actionType string Yes Bulk actions like automation. archive archives the given test cases and unarchive restores them (). Both need the right to delete the cases: the test case bulk update permission, or the delete permission (with its “only mine” variant, only for cases the caller created).
project number Yes —
testcaseIds Array of number Yes —
resume boolean No Applicable for automation only - Resume if single test case is selected
resumeFrom number No Applicable for automation only - Resume from step number if single test case is selected
editParams Test Case Bulk Action Edit Payload No —
editParams.overwrite_tags boolean No —
editParams.suite number No —
editParams.priority number No Priority, 0 - Low, 1- Normal, 2 - High Values: 0, 1, 2.
editParams.tags Array of number No Tag IDs array
editParams.custom_fields Array of Custom Field Input Payload No Array of custom fields
editParams.requirements Array of number No Requirement IDs array
editParams.overwrite_requirements boolean No —
reviewers Array of number No List of user ids (as reviewers)

Response

Section titled “Response”

200 — Test case bulk action result

Field Type Required Description
status boolean Yes —
affected number No —
details Array of Bulk Action Result Detail No —
message string Yes —
queue Background job No —
queue.id number Yes —
queue.status number Yes 0=queued; 1=in-progress; 2=done; 3=failed
queue.percent_done number Yes When status =1, this will indicate progress %
queue.created_at string Yes —
queue.updated_at string Yes —
queue.results string No JSON object
Illustrative response
{
  "status": true,
  "affected": 123,
  "details": [],
  "message": "example",
  "queue": {
    "id": 123,
    "status": 123,
    "percent_done": 123,
    "created_at": "example",
    "updated_at": "example",
    "results": "example"
  }
}

Errors

Section titled “Errors”
Status Meaning
401 Unauthorized
403 Forbidden
404 Not found
500 Internal server error

Next steps

Section titled “Next steps”