TestPlan

Update one 'TestPlan' entity

Update a single existing 'TestPlan' entity. Returns a full updated entity including (optional) modification metadata.

put/testplan/{id}

Request

Base URL
https://app.testiny.io/api/v1
Auth
API key in header X-Api-Key
TypeScript
https://skmtc.dev/testiny/apis/testiny-api/docs/testplan/:id/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

idinteger required

The id tof the object to update

Query parameters

forceboolean

Forces the update even if '_etag' is missing or not matching.

Request body

idinteger

The unique entity id - must be a positive integer

titlestring

A descriptive title for this entity or mapping (1 to 200 characters)

is_deletedboolean

If the entity has been soft-deleted this value is true

project_idinteger

The project id this entity or mapping belongs to

created_atstring date-time

The creation time for this entity or mapping value

created_bynumber

The creator user id of this entity or mapping value - or zero if created by the system

modified_atstring date-time

The last modification time for this entity or mapping value

modified_bynumber

The id of the user who last modified or undeleted this entity or mapping value - or zero if modified by the system

deleted_atstring date-time

The soft-deletion time for this entity or mapping value

deleted_bynumber

The id of the user who deleted this entity or mapping value - or zero if deleted by the system

descriptionstring

An optional description for this test plan (can be a rich text document, i.e. markdown with header line  or Testiny JSON format)

$testrun_countnumber

The number of test runs linked to this test plan - read only

$last_testrun_createdobject

The time the last test run was created from this test plan - read only

$open_testrun_countnumber

The number of open test runs linked to this test plan - read only

$query_countnumber

The number of tset case queries linked to this test plan - read only

Example request

{
  "title": "A Descriptive Title",
  "created_at": "1970-01-01T00:00:00.000Z",
  "modified_at": "1970-01-01T00:00:00.000Z",
  "deleted_at": "1970-01-01T00:00:00.000Z"
}

Response

Returns a single TestPlan