API Method ScenarioClear

Description

This method is used to remove all Domains and Receivers from a Scenario; this will enable a Scenario to be built from scratch. This method is useful because, in order to build a Scenario from scratch, a Scenario must first be loaded in order to validate a user's profile.

Exceptions

The following GenRocket exceptions may be thrown by this method:

• If the runtime instance is currently running another Scenario.

Runtime Method Signature

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

public void scenarioClear()

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": "scenarioClear",
  "parameters": {
  }
}

REST/Socket Payload Successful Payload Response

The API JSON response payload for this method will be empty.

{
  "responseType": "OK",
  "data": ""
}