element executeLdapQueryResponse

diagram |
namespace | http://directory.api.de.bpm.tibco.com
properties |
content | complex
children | ldap-entry
attributes |
Name | Type | Use | Default | Fixed | Annotation
ldap-alias | xs:string | required |  |  |
documentation
Identifies the LDAP connection shared resource on which the LDAP query was evaluated. LDAP connection shared Resource 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.
base-dn | xs:string | optional |  |  |
documentation
The base DN to which the query was restricted. This will be relative, and in additition to, any base DN specified in the LDAP connection shared resource's rURL.
ldap-query | xs:string | required |  |  |
documentation
The LDAP query that was evaluated.
search-scope | XmlLdapSearchScope | optional |  |  |
documentation
The Search Scope determines the depth to which the search will be performed. By default the search will be SUBTREE.
estimated-size | xs:int |  |  |  |
documentation
Estimated size of all results from LDAP server. Only specified if paged result sets are requested, and only if supported by the LDAP server.
bookmark | xs:string |  |  |  |
documentation
Opaque marker for progress through a paged result set. Specified but empty if there are no more results left in the paged result set. Response will be Base64 encoded.
annotation |
documentation
Response element for the executeLdapQuery operation. Returns the Distinguished Names (DNs) resolved by the given LDAP query.
source | <xs:element name="executeLdapQueryResponse"> <xs:annotation> <xs:documentation>Response element for the executeLdapQuery operation. Returns the Distinguished Names (DNs) resolved by the given LDAP query.</xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="ldap-entry" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The collection of fully Distinguished Names (DNs) resolved by the given LDAP query.</xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="ldap-dn" type="xs:string" use="required"/> </xs:complexType> </xs:element> </xs:sequence> <xs:attribute name="ldap-alias" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Identifies the LDAP connection shared resource on which the LDAP query was evaluated. LDAP connection shared Resource 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.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="base-dn" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>The base DN to which the query was restricted. This will be relative, and in additition to, any base DN specified in the LDAP connection shared resource's rURL.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="ldap-query" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The LDAP query that was evaluated.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="search-scope" type="de:XmlLdapSearchScope" use="optional"> <xs:annotation> <xs:documentation>The Search Scope determines the depth to which the search will be performed. By default the search will be SUBTREE.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="estimated-size" type="xs:int"> <xs:annotation> <xs:documentation>Estimated size of all results from LDAP server. Only specified if paged result sets are requested, and only if supported by the LDAP server.</xs:documentation> </xs:annotation> </xs:attribute> <xs:attribute name="bookmark" type="xs:string"> <xs:annotation> <xs:documentation>Opaque marker for progress through a paged result set. Specified but empty if there are no more results left in the paged result set. Response will be Base64 encoded.</xs:documentation> </xs:annotation> </xs:attribute> </xs:complexType> </xs:element>

attribute executeLdapQueryResponse/@ldap-alias

type | xs:string
properties |
use | required
annotation |
documentation
Identifies the LDAP connection shared resource on which the LDAP query was evaluated. LDAP connection shared Resource 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.
source | <xs:attribute name="ldap-alias" type="xs:string" use="required"> <xs:annotation> <xs:documentation>Identifies the LDAP connection shared resource on which the LDAP query was evaluated. LDAP connection shared Resource 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.</xs:documentation> </xs:annotation> </xs:attribute>

attribute executeLdapQueryResponse/@base-dn

type | xs:string
properties |
use | optional
annotation |
documentation
The base DN to which the query was restricted. This will be relative, and in additition to, any base DN specified in the LDAP connection shared resource's rURL.
source | <xs:attribute name="base-dn" type="xs:string" use="optional"> <xs:annotation> <xs:documentation>The base DN to which the query was restricted. This will be relative, and in additition to, any base DN specified in the LDAP connection shared resource's rURL.</xs:documentation> </xs:annotation> </xs:attribute>

attribute executeLdapQueryResponse/@ldap-query

type | xs:string
properties |
use | required
annotation |
documentation
The LDAP query that was evaluated.
source | <xs:attribute name="ldap-query" type="xs:string" use="required"> <xs:annotation> <xs:documentation>The LDAP query that was evaluated.</xs:documentation> </xs:annotation> </xs:attribute>

attribute executeLdapQueryResponse/@search-scope

type | XmlLdapSearchScope
properties |
use | optional
facets |
Kind | Value | Annotation
enumeration | ONELEVEL |
enumeration | SUBTREE |
annotation |
documentation
The Search Scope determines the depth to which the search will be performed. By default the search will be SUBTREE.
source | <xs:attribute name="search-scope" type="de:XmlLdapSearchScope" use="optional"> <xs:annotation> <xs:documentation>The Search Scope determines the depth to which the search will be performed. By default the search will be SUBTREE.</xs:documentation> </xs:annotation> </xs:attribute>

attribute executeLdapQueryResponse/@estimated-size

type | xs:int
annotation |
documentation
Estimated size of all results from LDAP server. Only specified if paged result sets are requested, and only if supported by the LDAP server.
source | <xs:attribute name="estimated-size" type="xs:int"> <xs:annotation> <xs:documentation>Estimated size of all results from LDAP server. Only specified if paged result sets are requested, and only if supported by the LDAP server.</xs:documentation> </xs:annotation> </xs:attribute>

attribute executeLdapQueryResponse/@bookmark

type | xs:string
annotation |
documentation
Opaque marker for progress through a paged result set. Specified but empty if there are no more results left in the paged result set. Response will be Base64 encoded.
source | <xs:attribute name="bookmark" type="xs:string"> <xs:annotation> <xs:documentation>Opaque marker for progress through a paged result set. Specified but empty if there are no more results left in the paged result set. Response will be Base64 encoded.</xs:documentation> </xs:annotation> </xs:attribute>

element executeLdapQueryResponse/ldap-entry

diagram |
properties |
minOcc | 0
maxOcc | unbounded
content | complex
attributes |
Name | Type | Use | Default | Fixed | Annotation
ldap-dn | xs:string | required |  |  |
annotation |
documentation
The collection of fully Distinguished Names (DNs) resolved by the given LDAP query.
source | <xs:element name="ldap-entry" minOccurs="0" maxOccurs="unbounded"> <xs:annotation> <xs:documentation>The collection of fully Distinguished Names (DNs) resolved by the given LDAP query.</xs:documentation> </xs:annotation> <xs:complexType> <xs:attribute name="ldap-dn" type="xs:string" use="required"/> </xs:complexType> </xs:element>

attribute executeLdapQueryResponse/ldap-entry/@ldap-dn

type | xs:string
properties |
use | required
source | <xs:attribute name="ldap-dn" type="xs:string" use="required"/>

XML Schema documentation generated by XMLSpy Schema Editor http://www.altova.com/xmlspy