Description

This method returns the map of generatorParameterName/Value pairs for a given Generator.


In This Article


Exceptions

The following GenRocket exceptions may be thrown by this method:  

  • If the requested domainName is not found.
  • If the requested receiverName is not found.
  • If the requested parameterName is not found.
  • If the generator position is out of bounds.


Runtime Method Signature

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


public Map<String, String> generatorParametersGet(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": "generatorParametersGet",
  "parameters": {
    "attributeName": "",
    "generatorPosition": ""
  }
}


REST/Socket Payload Successful Payload Response

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


{
  "responseType": "OK",
  "data": {
    "parameterName1": "value1",
    "parameterName2": "value2",
    "parameterNameN": "valueN"
  }
}