REST API - pagedquery
The table summarizes the REST API - pagedquery.
Request
Format | POST <baseurl>/directory/pagedquery/<ldapalias>/<page-size> |
Path parameters |
|
Query parameters |
|
Body | ldap-query: the query to be executed. |
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). Same bookmark and estimated-size values as described above. |
Example - First Request
Request | POST <baseurl>/directory/pagedquery/deLdap5/10 |
Request body | (objectClass=organizationalPerson) |
Response | { "xml-fragment": { "-ldap-alias": "deLdap5", "-ldap-query": "(objectClass=organizationalPerson)", "-search-scope": "SUBTREE", "-estimated-size": "0", "-bookmark": "ggzgZQ==", "ldap-entry": [ { "-ldap-dn": "UID=acresswell, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=adownes, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=ahardy, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=ahughes, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=arooney, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=asmith, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=awatts, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=awilson, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=amoses, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=aahmed, OU=employees, O=goCarInsuranceHeadOffice" } ] } } |
Example - Subsequent Request
Request | POST <baseurl>/directory/pagedquery/deLdap5/10?bookmark=ggzgZQ== |
Request body | (objectClass=organizationalPerson) |
Response | { "xml-fragment": { "-ldap-alias": "deLdap5", "-ldap-query": "(objectClass=organizationalPerson)", "-search-scope": "SUBTREE", "-estimated-size": "0", "-bookmark": "ggzgZQ==", "ldap-entry": [ { "-ldap-dn": "UID=aleijer, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=aboothroyd, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=asodje, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=abrown, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=acrawford, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=agoodall, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=agowling, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=ajones, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=amcneill, OU=employees, O=goCarInsuranceHeadOffice" }, { "-ldap-dn": "UID=amiller, OU=employees, O=goCarInsuranceHeadOffice" } ] } } |
Copyright © TIBCO Software Inc. All Rights Reserved.