Archive given test plan

PUT/testplan/archive/{id}

Archives specific test plan

Example

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

TypeScript SDK
HTTP

import { createConfiguration, TestPlansApi } from '@testcollab/sdk';

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

const result = await api.archiveTestPlan({
  "id": 123
});
console.log(result);

curl --request PUT \
  "https://api.testcollab.io/testplan/archive/123?token=$TESTCOLLAB_TOKEN"

Parameters

Name	Location	Type	Required	Description
`id`	path	number	Yes	Test Plan ID

Response

200 — Test Plan archived

Field	Type	Required	Description
`id`	number	Yes	—
`display_number`	number	No	Per-company human-readable business number (shown as TP-123). Distinct from the internal id.
`archived`	boolean	Yes	—
`title`	string	Yes	—
`priority`	number	Yes	Values: `0`, `1`, `2`.
`assigned_to`	Array of User Minified	Yes	—
`status`	number	Yes	0 = Draft; 1 = Ready to execute; 2 = Finish; 3 = Finished (with failures); Values: `0`, `1`, `2`, `3`.
`results`	Test Plan Results	No	—
`results.overall`	Result Summary	Yes	—
`results.overall.unexecuted`	number	Yes	—
`results.overall.passed`	number	Yes	—
`results.overall.failed`	number	Yes	—
`results.overall.skipped`	number	Yes	—
`results.overall.blocked`	number	Yes	—
`results.by_source`	object	No	Executed cases keyed by how the result was produced (manual, ci, api, agent, import), plus `not_recorded` for results predating this being tracked. Sits beside `overall` rather than inside it, because `overall` is keyed by status system name and an unknown key there renders as a custom status.
`results.configWise`	Array of object	Yes	—
`test_plan_folder`	Test Plan Folder	No	—
`test_plan_folder.id`	number	Yes	—
`test_plan_folder.project`	number	Yes	—
`test_plan_folder.title`	string	Yes	—
`test_plan_folder.parent_id`	number	Yes	—
`test_plan_folder.sort_order`	number	No	—
`test_plan_folder.testplancount`	number	No	—
`test_plan_folder.created_by`	number	No	—
`test_plan_folder.description`	string	No	—
`test_plan_folder.created_at`	string	Yes	—
`test_plan_folder.updated_at`	string	Yes	—
`estimate`	number	No	Estimated time for execution of this plan (in miliseconds)
`time_spent`	number	Yes	Time spent on execution of this plan (in seconds)
`created_by`	User Minified	Yes	—
`created_by.id`	number	Yes	—
`created_by.username`	string	No	—
`created_by.name`	string	Yes	—
`created_by.avatar`	Upload	No	—
`created_by.avatar.id`	number	Yes	—
`created_by.avatar.name`	string	Yes	—
`created_by.avatar.hash`	string	Yes	—
`created_by.avatar.ext`	string	Yes	—
`created_by.avatar.mime`	string	Yes	—
`created_by.avatar.size`	string	Yes	—
`created_by.avatar.url`	string	Yes	—
`created_by.avatar.created_by`	number	No	—
`created_by.avatar.created_at`	string	Yes	—
`created_by.avatar.updated_at`	string	Yes	—
`created_by.is_guest`	number	No	—
`actual_start_date`	string	No	—
`start_date`	string	No	—
`end_date`	string	No	—
`created_at`	string	Yes	—
`updated_at`	string	Yes	—
`last_run`	string	No	—
`description`	string	No	—
`custom_fields`	Array of Custom Field Collection Output	No	Array of custom fields
`is_public`	number	No	—
`release`	Release Minified	No	—
`release.id`	number	Yes	—
`release.name`	string	Yes	—
`release.status`	string	Yes	Values: `planned`, `in_progress`, `ready`, `shipped`, `blocked`.
`release.target_date`	string	No	—
`release.created_at`	string	No	—
`build`	Build Minified	No	Build (software version) this test plan’s results are traceable to ()
`build.id`	number	Yes	—
`build.version`	string	Yes	—
`build.environment`	string	No	—
`build.source`	string	Yes	Values: `manual`, `ci`.
`build.release_date`	string	No	—
`build.created_at`	string	No	—

{
  "id": 123,
  "display_number": 123,
  "archived": true,
  "title": "example",
  "priority": 0,
  "assigned_to": [],
  "status": 0,
  "results": {
    "overall": {
      "unexecuted": 123,
      "passed": 123,
      "failed": 123,
      "skipped": 123,
      "blocked": 123
    },
    "by_source": {},
    "configWise": []
  },
  "test_plan_folder": {
    "id": 123,
    "project": 123,
    "title": "example",
    "parent_id": 123,
    "sort_order": 123,
    "testplancount": 123,
    "created_by": 123,
    "description": "example",
    "created_at": "example"
  }
}

Errors

Status	Meaning
`401`	Unauthorized
`403`	Forbidden
`404`	Not found
`500`	Internal server error

Archive given test plan

Example

Parameters

Response

Errors

Next steps