API Method Scenarios

Description

This method returns the list of Scenario names. This method is useful for retrieving the list of Scenarios within a Scenario chain. The name are listed in the order they are to executed within the chain.

Exceptions

The following GenRocket exception may be thrown by this method:

• If no Scenarios loaded because scenarioLoad() has not been executed.

Runtime Method Signature

Use this method signature when directly accessing the GenRocket binary runtime.

public List<String> scenarios()

REST/Socket Payload Request

Use this API JSON request payload when making an API call to the GenRocket REST or Socket Engine.

{
  "interfaceType": "Manual",
  "methodName": "scenarios",
  "parameters": {
  }
}

REST/Socket Payload Successful Payload Response

The API JSON response payload may return a list of zero or more Domain names.

{
  "responseType": "OK",
  "data": [
    {
      "scenarioName": ""
    },
    {
      "scenarioName": ""
    },
    {
      "scenarioName": ""
    }
  ]
}