This method removes an Attribute from a given Domain.

Attribute Naming Convention

An attributeName has the format of domainName.attributeName.  If the domainName is not contained as the prefix of an attributeName, the domain will not be found.


  • User.lastName
  • Organization.title


The following GenRocket exceptions may be thrown by this method:  

  • If the runtime instance is currently running another Scenario.
  • If the requested domainName is not found.
  • If the requested attributeName is found.

Runtime Method Signature

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

 public void attributeRemove(String attributeName)

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": "attributeRemove",
  "parameters": {
    "attributeName": ""

REST/Socket Payload Successful Payload Response

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

  "responseType": "OK",
  "data": ""