Description

This method adds an Attribute to 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.

Examples:

  • User.lastName
  • Organization.title
  • Department.name


Exceptions

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 a duplicate attributeName is found.


Runtime Method Signature

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


public void attributeAdd(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": "attributeAdd",
  "parameters": {
    "attributeName": ""
  }
}


REST/Socket Payload Successful Payload Response

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


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