Description

This method returns the value of a given Generator parameter.


Exceptions

The following GenRocket exceptions may be thrown by this method:  

  • If the requested domainName is not found.
  • If the requested attributeName is not found.
  • If the requested parameterName is not found.
  • If the generatorPosition is out of bounds.


Runtime Method Signature

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


public Object generatorParameterGet(String attributeName, Integer generatorPosition, String parameterName)


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


REST/Socket Payload Successful Payload Response

The API JSON response payload returns the value of the given domain generatorParameter.


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