REST API - listAttributeNames

The table summarizes the REST API - listAttributeNames.

Request

Format 
GET <baseurl>/directory/attributes/<ldapalias>/<ldapquery>
Path parameters
  • ldapalias: the alias of the LDAP entry on which the query is evaluated. LDAP Connection Shared Resources are named with the prefix ldap/de/ in order to indicate that they are intended for Directory Engine use. The alias given here is that name without the ldap/de/ prefix. Can be obtained from a previous call to listLdapConnections .
  • ldapquery: the query being evaluated.
Query parameters
  • basedn=string (optional): the base Distinguished Name (DN) to which the query is restricted. This is relative to, and in addition to, any base DN specified in the LDAP Connection Shared Resource's URL.
  • samplesize=int (optional, default=0): the maximum number of randomly-selected LDAP entries to be returned.

Response

JSON Returns a JSON representation of the content of the listAttributeNamesResponse element.
XML Returns the content of the listAttributeNamesResponse element (from the DirectoryService schema).

Example

Request 
GET <baseurl>/directory/attributes/easyAs/%28objectclass=person%29?samplesize=1
Response 
 {
       "xml-fragment":
       {
           "@ldap-alias": "easyAs",
           "@ldap-query": "(objectclass=person)",
           "@entry-count": "8",
           "attribute":
           [
               {
                   "@name": "givenname",
                   "@binary": "false"
               },
               {
                   "@name": "employeetype",
                   "@binary": "false"
               },
           ],
           "sample-entry":
           {
               "@ldap-dn": "OU=Clint Hill, OU=Swindon, OU=AllEmployees, O=easyAsInsurance",
               "attribute":
               [
                   {
                       "@name": "givenname",
                       "@binary": "false",
                       "value": "Clint"
                   },
                   {
                       "@name": "employeetype",
                       "@binary": "false",
                       "value": "Permanent"
                   }
               ]
           }
       }
    }