Description

The DomainToggle method is used to enable or disable a Domain row to be generated based on the boolean value of an Attribute.


Exceptions

The following GenRocket exceptions may be thrown by this method:

  • If the runtime instance is currently running another Scenario
  • Unable to find Domain with domainName¬†
  • Unable to find Attribute with toggleEngineAttribute within the given Domain


Runtime Method Signature: To Enable/Disable Domain row 

Use this method signature when directly accessing the GenRocket Binary Runtime.


The format for toggleEngineAttribute is DomainName.AttributeName e.g. User.gender

public void domainToggle(String domainName, String toggleEngineAttribute)


REST/Socket Payload Request

Use this API JSON request payload when making an API call to the GenRocket REST or Socket Engine.
{
   "methodName": "domainToggle",
   "parameters": {
       "domainName": "",
       "toggleEngineAttribute": ""
   }
}