What's on this page

Scenarios

A Test Scenario is the main unit of behavior Testing within LM. Each Scenario is comprised of a sequence of configured test steps that will operate on a specific Test Assembly that has been configured to meet the specific needs of the test.

Get all Scenarios

Return the details of all the existing behavior Test Scenarios currently known to LM.

Request Format

Aspect Value
Endpoint URL /api/behaviour/scenarios
HTTP Method GET

No Parameters supported or required.

Response Format

Aspect Value
Response Code 200 – OK

Example Response Body

Response Body content type: application/json

[

  {

​    "id": "8e266bc5-e613-4b0d-9ae0-50db6454b026",

​    "name": "test-scale-in",

​    "projectId": "assembly::Test::1.0",

​    "description": "description",

​    "stages": [

​      {

​        "name": "string",

​        "steps": [

​          {

​            "stepDefinitionName": "string"

​            "properties": {

​              "additionalProp1": "string",

​              "additionalProp2": "string",

​              "additionalProp3": "string"

​            },

​          }

​        ]

​      }

​    ],

​    "assemblyActors": [

​      {

​        "assemblyConfigurationId": "string",

​        "initialState": "string",

​        "instanceName": "string",

​        "provided": true,

​        "uninstallOnExit": true

​      }

​    ],

​    "createdAt": "2019-03-01T14:41:07.716Z",

​    "lastModifiedAt": "2019-03-01T14:41:07.716Z"

  }

]

 

Response properties

Property Name Description Mandatory
id Unique identifier for the behavior Test Scenario. This can be any text string, it is not limited to GUIDs. Yes
name Textual name of the Scenario Yes
description Description of the Scenario as supplied when it was created Yes
createdAt Date and time the Scenario was created Yes
lastModifiedAt Date and time the Scenario was last modified Yes
stages A list of the individual behavior Test Stages that comprise the Scenario. Yes
name Textual name of an individual behavior Test Stage Yes
steps A list of the individual behavior Test Steps that comprise a single Test Stage. Yes
stepDefinitionName Textual name of a Test Step. This name must match the name of an existing Test Step known to LM. Yes
properties An array of Name-Value pairs where each pair defines one Test Step property and its associated value. Yes
assemblyActors A list of Assembly Configurations used within the Scenario. Yes
assemblyConfigurationId The unique ID of the Assembly Configuration to be used by this Test Scenario. Yes
initialState The initial state the Test Assembly is to be placed in. Shall be one of “Installed”, “Inactive” or “Active” Yes
instanceName The name of the Test Assembly once it has been installed. No
provided Indicates whether the name of the Test Assembly will be provided as part of the Test Scenario itself. Supported values are “true” or “false”. If set to “false” then the “instanceName” must be supplied. Yes
uninstallOnExit Indicates whether the Test Assembly to be uninstalled once the Test Scenario has completed. Supported values are “true” or “false” Yes

Get a single Scenario

Return the details of a single existing behavior Test Scenario currently known to LM.

Request Format

Aspect Value
Endpoint URL /api/behaviour/scenarios/{scenarioId}
HTTP Method GET

Request parameters

Parameter Name Description Mandatory
scenarioId Unique identifier of the behavior Test Scenario to be returned. This can be any text string. Yes

Response Format

Aspect Value
Response Code 200 – OK 404 – No matching Test Scenario found

Example Response Body

For a 200 Response Code:

Response Body content type: application/json

 

[

  {

​    "id": "8e266bc5-e613-4b0d-9ae0-50db6454b026",

​    "name": "test-scale-in",

​    "projectId": "assembly::Test::1.0",

​    "description": "description",

​    "stages": [

​      {

​        "name": "string",

​        "steps": [

​          {

​            "stepDefinitionName": "string"

​            "properties": {

​              "additionalProp1": "string",

​              "additionalProp2": "string",

​              "additionalProp3": "string"

​            },

​          }

​        ]

​      }

​    ],

​    "assemblyActors": [

​      {

​        "assemblyConfigurationId": "string",

​        "initialState": "string",

​        "instanceName": "string",

​        "provided": true,

​        "uninstallOnExit": true

​      }

​    ],

​    "createdAt": "2019-03-01T14:41:07.716Z",

​    "lastModifiedAt": "2019-03-01T14:41:07.716Z"

  }

]

 

For a 40x, 500 or any other error response please see error responses

Response properties

Property Name Description Mandatory
id Unique identifier for the behavior Test Scenario. This can be any text string, it is not limited to GUIDs. Yes
name Textual name of the Scenario Yes
description Description of the Scenario as supplied when it was created Yes
createdAt Date and time the Scenario was created Yes
lastModifiedAt Date and time the Scenario was last modified Yes
stages A list of the individual behavior Test Stages that comprise the Scenario. Yes
name Textual name of an individual behavior Test Stage Yes
steps A list of the individual behavior Test Steps that comprise a single Test Stage. Yes
stepDefinitionName Textual name of a Test Step. This name must match the name of an existing Test Step known to LM. Yes
properties An array of Name-Value pairs where each pair defines one Test Step property and its associated value. Yes
assemblyActors A list of Assembly Configurations used within the Scenario. Yes
assemblyConfigurationId The unique ID of the Assembly Configuration to be used by this Test Scenario. Yes
initialState The initial state the Test Assembly is to be placed in. Shall be one of “Installed”, “Inactive” or “Active” Yes
instanceName The name of the Test Assembly once it has been installed. No
provided Indicates whether the name of the Test Assembly will be provided as part of the Test Scenario itself. Supported values are “true” or “false”. If set to “false” then the “instanceName” must be supplied. Yes
uninstallOnExit Indicates whether the Test Assembly to be uninstalled once the Test Scenario has completed. Supported values are “true” or “false” Yes