Class: ExecutePagedLdapQueryRequest

tibco.objectapi.service.request.ExecutePagedLdapQueryRequest

new ExecutePagedLdapQueryRequest(query, ldapAlias, pageSize)

Object ExecutePagedLdapQueryRequest Usage: RestApiService.getDirectoryService().executePagedLdapQuery(request, callback);
Parameters:
Name Type Description
query string The LDAP Query to be executed.
ldapAlias string The alias of the LDAP shared resource on which the paged query is executed. 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.
pageSize number (Java type: int) Maximum number of results to be returned in result set.
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

bookmark :string

Query parameter: 'bookmark' This parameter is not passed in the first call to get paged results; it is obtained from the response to the first call, then passed in subsequent calls to get additional pages of results - must be Base64 encoded.
Type:
  • string
Since:
  • 4.0.0

scope :string

Query parameter: '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
Default Value:
  • = SUBTREE