Applies to ReadyAPI 2.2, last modified on November 17, 2017

After you send a test recipe to ReadyAPI TestServer for execution, TestServer immediately returns a response with the execution status.

In most cases, your test will just start, so the response will have the INITIALIZED status. Some short test recipes may complete by the time you receive the response. In this case, you will get the FINISHED status. Also, if the execution has finished, you can see if it was successful or not.

In any case, the response contains the executionID value. You can use this value to retrieve additional information about the latest test run. To do this, pass this value to the following request:

curl --user Tester:test -X GET -k https://localhost:8443/v1/readyapi/executions/YOUR-EXECUTION-ID/status

You can run requests like this one several times until your recipe execution is FINISHED.

Here is an example:

API testing with ReadyAPI TestServer: Sample test recipe results

The table below provides descriptions of the response fields:

Name Value
startTime The timestamp of the execution start.
status The execution status.
timeTaken The number of milliseconds it took TestServer to run the recipe.
projectName The name of a project. Recipe REST Project is the default name for recipe projects.
unresolvedDataSources If your test case includes data sources, you will need to send the data source file as an extra request. Until then, the data source will be unresolved. For more information on passing files to TestServer, see Sending Files for Data-Driven Tests.
testSuiteResultReports An array of test suite results. JSON recipes have one test suite result item. If you run a ReadyAPI project, the number of result items corresponds to the number of executed test suites.
testSuiteName The name of a test suite. Recipe Test Suite is the default name for recipe projects.
testCaseResultReports An array of test case results. JSON recipes have one test case result item. If you run a ReadyAPI project or a test suite, the number of result items corresponds to the number of executed test cases.
testCaseName The name of a test case.
testStepResultReports An array of individual test step results.
messages Error messages. Usually empty for successful test steps. Contain an error description for the failed test steps.
timeTaken The number of milliseconds it took TestServer to execute a test step.
testStepName The test step’s name.
assertionStatus The result of an assertion.
transactionId The identifier of the test step transactions.
executionID The identifier of the test run.
You can also get the .har transaction log. Send a GET request to the following URL: /v1/readyapi/executions/{executionId}/logs. See the detailed instructions in Get Transaction Logs.

Prev     Next

See Also

Get Transaction Logs
Creating Your First Recipe