Get all scenarios

Use this information to retrieve all scenarios in a behavior testing project (descriptor).

The following elements are described:

Request

Aspect Value
Endpoint URL /api/behaviour/scenarios?projectId={projectId}
HTTP Method GET

Query parameters

Aspect Description Mandatory
projectId ID of the behavior testing project (usually the descriptor name) Yes

Response

Aspect Value
Content-Type application/json
Response Code 200 (OK)

Body

Field Description
id ID assigned to the scenario
name Name of the scenario
description Supplied description of the scenario
projectId Unique identifier for the behavior test project that this assembly configuration belongs to
stages A list of stages, each containing the steps to execute in this scenario
assemblyActors A list of assembly configurations to use within the scenario
createdAt Date and time the scenario instance was created
lastModifiedAt Date and time the scenario instance was last modified
Each stages entry contains the following fields:
Field Description
name Name of the stage
steps List of steps to execute in this stage
Each assemblyActors entry contains the following fields:
Field Description
instanceName Name to refer to this actor throughout the scenario. If the instance is one to be instantiated, this name is used as the instance name.
assemblyConfigurationId ID of the assembly configuration to instantiate this instance from
initialState State to create the instance in (Installed, Inactive, or Active)
uninstallOnExit Enable/disable the uninstallation of the instance after the scenario completes successfully
provided Dictates if the actor is an existing instance of an assembly or to be instantiated from an assembly configuration

Example

[
  {
  ​    "id": "8e266bc5-e613-4b0d-9ae0-50db6454b026",
  ​    "name": "test-scale-in",
  ​    "projectId": "assembly::Test::1.0",
  ​    "description": "description",
      "createdAt": "2019-03-01T14:41:07.716Z",
  ​    "lastModifiedAt": "2019-03-01T14:41:07.716Z",
  ​    "stages": [
  ​      {
  ​        "name": "Test Stage",
  ​        "steps": [
  ​          {
  ​            "stepDefinitionName": "IntentEngine::CreateAssembly"
  ​            "properties": {
  ​              "additionalProp1": "string",
  ​              "additionalProp2": "string",
  ​              "additionalProp3": "string"
  ​            },
  ​          }
  ​        ]
  ​      }
  ​    ],
  ​    "assemblyActors": [
  ​      {
  ​        "assemblyConfigurationId": "7f456ac3-a523-2c1d-2cd1-42dc6124b012",
  ​        "initialState": "Active",
  ​        "instanceName": "TestInstance",
  ​        "provided": false,
  ​        "uninstallOnExit": true
  ​      }
  ​    ]
  },
  ...
]