Description

This method is used to list the Attribute names of 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 requested domainName is not found.


Runtime Method Signature

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


public List<String> attributes(String domainName)


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": "attributes",
  "parameters": {
    "domainName": ""
  }
}


REST/Socket Payload Successful Payload Response

The API JSON response payload returns the list of zero or more Attribute names for the given Domain.


{
  "responseType": "OK",
  "data": [
    {
      "attributeName": ""
    },
    {
      "attributeName": ""
    },
    {
      "attributeName": ""
    }
  ]
}