Create scenario run

Creates a new run for a test scenario. The run is executed immediately.

PUT /manage/scenarios/{scenarioId}/run

URI Parameters

Name In Required Type Description

scenarioId

path

True

string

Version 4 UUID of the test scenario

Request Body

Request body is not required

Responses

Name Type Description

201 Created

ScenarioRun

The new ScenarioRun

Produces

  • application/json

Security

Every request requires a JWT access token for authentication in the Authorisation HTTP header. Please see the API authentication page for details about how to get a JWT token.

Authorization: Bearer {JWT_TOKEN}

Roles

  • Wenenu Owner

  • Wenenu Contributor

Sample request

PUT https://wenenu.com/manage/scenarios/ff7f45bb-feeb-48b5-a228-ec3a057eefac/run HTTP/1.1
Authorization: Bearer {jwt_token}

Sample Response

Status code: 201

{
  "id":"2cbde4a4-e17b-4636-9d0c-877597e23897",
  "state":"NOT STARTED",
  "scheduledTime":"2021-10-31T12:40:54.452+00:00",
  "startTime":null,
  "endTime":null,
  "stepCount":1,
  "finished":0,
  "skipped":0,
  "failed":0,
  "reportDone":false,
  "scenarioId":"ff7f45bb-feeb-48b5-a228-ec3a057eefac"
}

Definitions

ScenarioRun

Name Type Description

id

string

Version 4 UUID of the scenario run

scenarioId

string

Version 4 UUID of the scenario to which the scenario run belongs

scheduledTime

string

The scheduled date and time of the scenario run in ISO 8601 format

startTime

string

Date and time of the actual start of the scenario run in ISO 8601 format

endTime

string

Date and time of the end of the scenario run in ISO 8601 format

state

string

The state of the scenario run, possible values are NOT STARTED, RUNNING, FAILED and FINISHED

stepCount

integer

The total number of test steps in the scenario run

finished

integer

The number of finished test steps in the scenario run

failed

integer

The number of failed test steps in the scenario run

skipped

integer

The number of skipped test steps in the scenario run

reportDone

boolean

True if the PDF report of the scenario run is ready for download