API Method GeneratorName

This method returns the name of a Generator for a given Attribute for a given position.

Exceptions

The following GenRocket exceptions may be thrown by this method:

• If the requested attributeName is not found.

Runtime Method Signature

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

String generatorName(String attributeName, Integer generatorPosition)

generatorPosition Parameter

The generatorPosition parameter starts at 0 (zero) against the Attribute Generator or Linked Generators, as shown below:

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": "generatorName",
  "parameters": {
    "attributeName": "",
    "generatorPosition":""
  }
}

REST/Socket Payload Successful Payload Response

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

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