REST API - executeLargeLdapQuery
The table summarizes the REST API - executeLargeLdapQuery.
Request
Format | POST <baseurl>/directory/query/<ldapalias>/<ldapquery> |
Path parameters |
|
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. |
Body | ldap-query (optional): the parameter from the executeLdapQuery element (from the DirectoryService schema) that defines the query to be evaluated. The query must conform to the RFC 2254 LDAP Search Filter standard. |
Response
JSON | Returns a JSON representation of the content of the executeLdapQueryResponse element. |
XML | Returns the content of the executeLdapQueryResponse element (from the DirectoryService schema). |
Example
Request | POST <baseurl>/directory/query/easyAs?basedn=ou%3DLondon,ou%3DAllEmployees |
Request body | (employeetype=Permanent) |
Response | { "xml-fragment": { "@ldap-alias": "easyAs", "@ldap-query": "(employeetype=Permanent)", "@base-dn": "ou=London,ou=AllEmployees", "ldap-entry": [ { "@ldap-dn": "OU=Richard Cresswell, OU=London, OU=AllEmployees, O=easyAsInsurance" }, { "@ldap-dn": "OU=Steve Simonsen, OU=London, OU=AllEmployees, O=easyAsInsurance" }, { "@ldap-dn": "OU=Tony Pulis, OU=London, OU=AllEmployees, O=easyAsInsurance" } ] } } |
Copyright © TIBCO Software Inc. All Rights Reserved.