Test Run API (1.0.0)

Download OpenAPI specification:Download

Create a new (empty) run

Creates a new test run in Testomat.io, which can be used to report the results of multiple tests. Returns a unique ID for the run.

query Parameters

api_key

required

string

The API key for your Testomat.io account

Request Body schema: application/json

title	string The title of the test run
tags	Array of strings An array of tags to associate with the test run
env	string The environment the test run was executed in
group_title	string Add a run to rungroup matching this group by its title. If rungroup does not exist, it will be created.
parallel	boolean Whether to create a prallell run

Responses

Request samples

Payload

Content type

application/json

{"title": "string",
"tags": ["string"
],
"env": "string",
"group_title": "string",
"parallel": true
}

Response samples

200

Content type

application/json

{"uid": "string",
"url": "string"
}

Update or finish existing run

Updates an existing test run in Testomat.io, which can be used to report the results of multiple tests. Requires a unique ID for the test run.

path Parameters

runId

required

string

The unique ID of the test run

query Parameters

api_key

required

string

The API key for your Testomat.io account

Request Body schema: application/json

status_event	string (RunStatusEvent) Enum: "pass" "fail" "finish" "pass_parallel" "fail_parallel" "finish_parallel" The final status of the run. Suffix _parallel and marks that only one part of this run has finished. To finish parallel run, send additional request with status=finish. Set status explicitly with `pass` or `fail` statuses or use `finish` status to calculate final status from test run results.
create_tests	boolean Whether to create new tests or update existing ones
tests_count	integer The total number of tests to be run
passed_count	integer The number of tests that passed
failed_count	integer The number of tests that failed
skipped_count	integer The number of tests that were skipped
	Array of objects (TestData) The details of each test

Responses

Request samples

Payload

Content type

application/json

{"status_event": "pass",
"create_tests": true,
"tests_count": 0,
"passed_count": 0,
"failed_count": 0,
"skipped_count": 0,
"tests": [{"status": "passed",
"title": "string",
"suite_title": "string",
"suite_id": "string",
"test_id": "string",
"message": "string",
"stack": "string",
"run_time": 0,
"example": { },
"artifacts": ["string"
],
"steps": "string",
"code": "string"
}
]
}

Send test results for a test run

path Parameters

runId

required

string

The ID of the test run to report results for

query Parameters

apiKey

required

string

Your Testomat.io API key

Request Body schema: application/json

The test data to report

status	string (TestStatus) Enum: "passed" "failed" "skipped"
title	string The title of the test
suite_title	string The title of the test suite
suite_id	string The ID of the test suite
test_id	string The ID of the test
message	string A message describing the error
stack	string A stack trace for the error
run_time	number The time it took to execute the test, in seconds
example	object An example associated with the test
artifacts	Array of strings An array of URLs for uploaded artifacts associated with the test
steps	string The steps taken during the test
code	string The code executed during the test

Responses

Request samples

Payload

Content type

application/json

{"status": "passed",
"title": "string",
"suite_title": "string",
"suite_id": "string",
"test_id": "string",
"message": "string",
"stack": "string",
"run_time": 0,
"example": { },
"artifacts": ["string"
],
"steps": "string",
"code": "string"
}