Get a run of a test scenario

Retrieves a run of a test scenario

GET /manage/scenarios/{scenarioId}/runs/{runId}

URI Parameters

Name In Required Type Description

scenarioId

path

True

string

Version 4 UUID of the test scenario

runId

path

True

string

Version 4 UUID of the scenario run

Responses

Name Type Description

200 OK

ScenarioRun

Scenario run 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/8a444458-3fc2-4019-94c0-5c1bd973d2d5/runs/69c65310-1460-49ba-a791-c274a334ac9c HTTP/1.1
Authorization: Bearer {jwt_token}

Sample Response

Status code: 200 OK

{
  "id": "69c65310-1460-49ba-a791-c274a334ac9c",
  "state": "FINISHED",
  "scheduledTime": "2020-11-20T18:27:21.904+00:00",
  "startTime": "2020-11-20T18:27:22.637+00:00",
  "endTime": "2020-11-20T18:42:42.904+00:00",
  "stepCount": 3,
  "finished": 3,
  "skipped": 0,
  "failed": 0,
  "reportDone": true,
  "steps": [
    {
      "id": "0c4c05d7-5105-4c11-98a9-02957da657f7",
      "state": "FINISHED",
      "type": "asr",
      "displayName": "Azure Site Recovery",
      "sequence":1,
      "startTime": "2020-11-20T18:27:22.642+00:00",
      "endTime": "2020-11-20T18:38:53.251+00:00",
      "scenarioRunId": "69c65310-1460-49ba-a791-c274a334ac9c"
    },
    {
      "id": "bfeb3332-13a6-4140-b9f1-c4417157644b",
      "state": "FINISHED",
      "type": "php",
      "displayName": "PHP",
      "sequence":2,
      "startTime": "2020-11-20T18:38:54.055+00:00",
      "endTime": "2020-11-20T18:38:56.235+00:00",
      "scenarioRunId": "69c65310-1460-49ba-a791-c274a334ac9c"
    },
    {
      "id": "0d9ae45a-2b5c-4831-b22d-277986d1d14e",
      "state": "FINISHED",
      "type": "stopasr",
      "displayName": "Stop: Azure Site Recovery",
      "sequence":3,
      "startTime": "2020-11-20T18:38:57.118+00:00",
      "endTime": "2020-11-20T18:42:42.469+00:00",
      "scenarioRunId": "69c65310-1460-49ba-a791-c274a334ac9c"
    }
  ],
  "scenarioId": "8a444458-3fc2-4019-94c0-5c1bd973d2d5"
}

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

steps

ScenarioRunStep[]

List of test steps of the scenario run

ScenarioRunStep

Name Type Description

id

string

Version 4 UUID of the scenario run step

scenarioRunId

string

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

state

string

The state of the scenario run step, possible values are 'NOT STARTED', 'AGENT WAITING', 'RUNNING', 'SKIPPED', 'FAILED' and 'FINISHED'

type

string

Type of the scenario run step

displayName

string

Display name of the scenario run step

sequence

integer

Sequence of the run step in the scenario run

startTime

string

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

endTime

string

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