List test scenarios

Retrieves the list of test scenarios

GET /manage/scenarios?offset={offset}&limit={limit}

URI Parameters

Name In Required Type Description

offset

query

False

integer

Offset of the first test scenario in the list, default: 0

limit

query

False

integer

Maximum number of test scenarios returned, default: 20, maximum: 100

Responses

Name Type Description

200 OK

ScenarioListResponse

Scenario list response object

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

  • Wenenu Reader

Sample request

GET https://wenenu.com/manage/scenarios?offset=0&limit=20 HTTP/1.1
Authorization: Bearer {jwt_token}

Sample Response

Status code: 200

{
  "result": [
    {
      "id": "8a444458-3fc2-4019-94c0-5c1bd973d2d5",
      "tenantId": "68ff0057-88be-4c42-8a67-75624b92b873",
      "name": "Full environment test",
      "version": 13,
      "scheduled": true,
      "frequency": "WEEKLY",
      "timeZone": "Europe/London",
      "minute": 20,
      "hour": 3,
      "daysOfWeek": "2,7",
      "daysOfMonth": null,
      "emailReportEnabled": false,
      "emailReportTimeZone": "Europe/London",
      "nextScheduledRun": "2021-04-25T07:20:00.000+00:00",
      "lastStarted": "2021-04-21T09:36:44.848+00:00",
      "previousRuns": [
        {
          "id": "3fb5dcec-aa68-4771-8a7b-7809256b3892",
          "scheduledTime": "2021-04-21T09:36:41.652+00:00",
          "startTime": "2021-04-21T09:36:45.039+00:00",
          "endTime": "2021-04-21T17:14:12.265+00:00",
          "state": "FINISHED",
          "stepCount": 91,
          "finished": 91,
          "failed": 0,
          "skipped": 0
        },
        {
          "id": "4b1a9327-ba33-4ddb-808a-b1f83cae333c",
          "scheduledTime": "2021-04-21T09:32:10.815+00:00",
          "startTime": "2021-04-21T09:32:12.632+00:00",
          "endTime": "2021-04-21T17:09:40.702+00:00",
          "state": "FAILED",
          "stepCount": 91,
          "finished": 81,
          "failed": 10,
          "skipped": 0
        }
      ],
      "emailReportAddresses": [
        "user1@wenenu.com"
      ]
    }
  ],
  "total":1
}

Definitions

ScenarioListResponse

Name Type Description

result

Scenario[]

List of the requested scenarios

total

long

Total number of scenarios

Scenario

Name Type Description

id

string

Version 4 UUID of the scenario

tenantId

string

Version 4 UUID of the Wenenu tenant of the scenario

name

string

Arbitrary name of the test scenario up to 256 characters

version

integer

Version number of the configuration of the scenario

scheduled

boolean

True if the scenario is scheduled for execution

frequency

string

Frequency of the schedule of the scenario, possible values are HOURLY, DAILY, WEEKLY and MONTHLY

timeZone

string

TZ database name of the timezone of the scenario scheduling

minute

integer

The minute of the scenario scheduling 0..59

hour

integer

The hour of the scenario scheduling 0..23

daysOfWeek

string

Comma-separated list of days of the week for weekly scenario scheduling, 1 - Monday, 7 - Sunday

daysOfMonth

string

Comma-separated list of days of the month for monthly scenario scheduling

emailReportEnabled

boolean

True if the run reports are sent out via email

emailReportTimeZone

string

TZ database name of the timezone of the run repoorts

nextScheduleRun

string

Date and time of the next scheduled execution in ISO 8601 format

lastStarted

string

Date and time of the last execution in ISO 8601 format

previousRuns

PreviousRun[]

Details of the last ten runs of the scenario

emailReportAddresses

string[]

List of email addresses to which the run reports are emailed, maximum three

PreviousRun

Name Type Description

id

string

Version 4 UUID of the scenario run

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