Skip to content
developers
Open TestCollab

Update testplan test cases in bulk

POST/testplantestcases/bulkAction

Update testplan test cases in bulk

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, TestPlanTestCasesApi } from '@testcollab/sdk';


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


const result = await api.bulkUpdateTestplanCases({
  "bulkUpdateTestplanCasesPayload": {
    "actionType": "pass",
    "testcases": [],
    "project": 123,
    "testplan": 123
  }
});
console.log(result);

Request body

Section titled “Request body”
Field Type Required Description
actionType string Yes Values: pass, fail, skip, block, assign, retest, update.
testcases Array of number Yes Test Case IDs
project number Yes Project ID
testplan number Yes Test plan ID
test_plan_config number No Test Plan’s Configuration ID
regression number No Test Plan Regression’s ID
comment string No —
attachments Array of string No Array of file ids
status string No Executed test case status (passed, failed, skipped, blocked, assigned, retest)
time_taken number No Number of seconds taken for this test
assignedTo number No —

Response

Section titled “Response”

200 — Bulk update 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”