Skip to content
developers
Open TestCollab

Bulk add test cases to a test plan

POST/testplantestcases/bulkAdd

Array of test cases IDs -or- array of filter queries

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.bulkAddTestPlanTestCases({
  "testPlanTestCaseBulkAddPayload": {
    "testplan": 123
  }
});
console.log(result);

Request body

Section titled “Request body”
Field Type Required Description
testplan number Yes —
testCaseCollection Test Case Ref Collection No —
testCaseCollection.testCases Array of number No Array of test case IDs
testCaseCollection.selector Array of Filter Query No FilterQuery object to match test cases
assignee number No Applicable only when adding testcase(s) to a testplan which has testcases

Response

Section titled “Response”

200 — Action status details

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”