Schedule regular execution of a test scenario
Sets the scheduling of a test scenario
PUT /manage/scenarios/{scenarioId}/schedule
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
scenarioId |
path |
True |
|
Version 4 UUID of the test scenario |
Request Body
Name | Type | Required | Description |
---|---|---|---|
scheduled |
|
True |
True if the scenario scheduling is enabled |
frequency |
|
True |
The frequency of the scenario scheduling, possible values are HOURLY, DAILY, WEEKLY and MONTHLY |
timeZone |
|
True |
TZ database name of the timezone of the scenario scheduling |
minute |
|
True |
Minute of the schedule, 0..59 |
hour |
|
False |
Hour of the schedule, 0..23, required if the frequency is DAILY, WEEKLY or MONTHLY |
daysOfWeek |
|
False |
Comma separated list of days of week, 1 - Monday, 7 - Sunday, length 0-13, regex pattern |
daysOfMonth |
|
False |
Comma separated list of days of month, length 0-83, regex pattern |
Responses
Name | Type | Description |
---|---|---|
200 OK |
The scehduled scenario object |
Consumes
-
application/json
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/55808630-8329-48d6-9674-108365366dc9/schedule HTTP/1.1
Authorization: Bearer {jwt_token}
Content-type: application/json
Request body:
{
"scheduled": true,
"timeZone": "Europe/London",
"frequency": "WEEKLY",
"minute": 20,
"hour": 3,
"daysOfWeek": "1,2,3,4,5,6,7"
}
Sample Response
Status code: 200 OK
Body:
{
"id": "55808630-8329-48d6-9674-108365366dc9",
"tenantId": "108365366dc9-88be-4c42-8329-55808630",
"name": "My new edited scenario",
"version": 0,
"scheduled": true,
"frequency": "WEEKLY",
"timeZone": "Europe/London",
"minute": 20,
"hour": 3,
"daysOfWeek": "1,2,3,4,5,6,7",
"daysOfMonth": null,
"emailReportEnabled": false,
"emailReportTimeZone": "Europe/London",
"nextScheduledRun": "2021-01-10T03:20:00.000+00:00",
"lastStarted": null,
"previousRuns": [
],
"emailReportAddresses": []
}
Definitions
Scenario
Name | Type | Description |
---|---|---|
id |
|
Version 4 UUID of the scenario |
tenantId |
|
Version 4 UUID of the Wenenu tenant of the scenario |
name |
|
Arbitrary name of the test scenario up to 256 characters |
version |
|
Version number of the configuration of the scenario |
scheduled |
|
True if the scenario is scheduled for execution |
frequency |
|
Frequency of the schedule of the scenario, possible values are HOURLY, DAILY, WEEKLY and MONTHLY |
timeZone |
|
TZ database name of the timezone of the scenario scheduling |
minute |
|
The minute of the scenario scheduling 0..59 |
hour |
|
The hour of the scenario scheduling 0..23 |
daysOfWeek |
|
Comma-separated list of days of the week for weekly scenario scheduling, 1 - Monday, 7 - Sunday |
daysOfMonth |
|
Comma-separated list of days of the month for monthly scenario scheduling |
emailReportEnabled |
|
True if the run reports are sent out via email |
emailReportTimeZone |
|
TZ database name of the timezone of the run repoorts |
nextScheduleRun |
|
Date and time of the next scheduled execution in ISO 8601 format |
lastStarted |
|
Date and time of the last execution in ISO 8601 format |
previousRuns |
Details of the last ten runs of the scenario |
|
emailReportAddresses |
|
List of email addresses to which the run reports are emailed, maximum three |
PreviousRun
Name | Type | Description |
---|---|---|
id |
|
Version 4 UUID of the scenario run |
scheduledTime |
|
The scheduled date and time of the scenario run in ISO 8601 format |
startTime |
|
Date and time of the actual start of the scenario run in ISO 8601 format |
endTime |
|
Date and time of the end of the scenario run in ISO 8601 format |
state |
|
The state of the scenario run, Possible values are NOT STARTED, RUNNING, FAILED and FINISHED |
stepCount |
|
The total number of test steps in the scenario run |
finished |
|
The number of finished test steps in the scenario run |
failed |
|
The number of failed test steps in the scenario run |
skipped |
|
The number of skipped test steps in the scenario run |