AutomationTestRun

Create a new 'AutomationTestRun' entity

Creates a new 'AutomationTestRun' entity. Returns full entity with new id and (optional) creation metadata.

post/atm-testrun

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/atm-testrun/post.ts
A function with typed inputs. Its response is checked against the schema.

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)

project_idinteger

The project id this entity or mapping belongs to

closed_atstring date-time

The time this automation test run was closed

closed_bynumber

The id of the user who closed this automation test run

is_closedboolean

Whether the automation test run is closed or not. While certain properties of a closed automation test run may still be modified, some referenced entities (e.g. test cases, results, ...) before the 'closed_at' date cannot be removed or changed until it is reopened.

tagsstring

A list of tags for this entity

atm_source_idinteger

The atm_source_id property

min_timestampnumber

The min_timestamp property

max_timestampnumber

The max_timestamp property

last_update_timestampnumber

The last_update_timestamp property

durationnumber

The duration property

status_highestnumber

The highest result status in this run, see the ordering of the result status values

is_completedboolean

The is_completed property

is_pinnedboolean

The is_pinned property

key_fields_rawAutomationKeyRawFields

descriptionstring nullable

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

stat_passed_countnumber

Number of passed results in this run

stat_passed_warn_countnumber

Number of passed with warning results in this run

stat_skipped_countnumber

Number of skipped results in this run

stat_blocked_countnumber

Number of blocked results in this run

stat_failed_countnumber

Number of failed results in this run

Example request

{
  "title": "A Descriptive Title",
  "closed_at": "1970-01-01T00:00:00.000Z",
  "tags": "important,release,smoketest"
}

Response

Returns a single AutomationTestRun