Class: ListAttributeNamesLargeQueryRequest

tibco.objectapi.service.request.ListAttributeNamesLargeQueryRequest

new ListAttributeNamesLargeQueryRequest(query, ldapAlias)

Object ListAttributeNamesLargeQueryRequest Usage: RestApiService.getDirectoryService().listAttributeNamesLargeQuery(request, callback);
Parameters:
Name Type Description
query string The LDAP Query to be evaluated.
ldapAlias string 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.
Since:
  • 4.0.0

Members

baseDn :string

Query parameter: 'basedn' (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.
Type:
  • string
Since:
  • 4.0.0

sampleSize :number

Query parameter: 'samplesize' (Java type: int) The maximum number of randomly-selected LDAP entries to be returned.
Type:
  • number
Since:
  • 4.0.0
Default Value:
  • = 0

searchScope :string

Query parameter: 'search-scope' (optional) The starting point of an LDAP search and the depth from the base DN to which the search should occur. The valid values are:
  • SUBTREE - elements directly within, and below, the Base-DN level are searched.
  • ONELEVEL - only the elements directly within the Base-DN level are searched.
Type:
  • string
Since:
  • 4.0.0