element listCandidateResourcesResponse
diagram dir_directoryservice_diagrams/dir_directoryservice_p17.png
namespace http://directory.api.de.bpm.tibco.com
properties
content complex
children candidate
attributes
Name  Type  Use  Default  Fixed  Annotation
container-id  xs:long  required      
documentation
Identifies the LDAP container from which the candidates were resolved.
include  XmlCandidateChoice    ALL    
documentation
Indicates what entries are be included in the collection of candidate entries.
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 listCandidateResources operation.  Returns a list of candidate resources from the requested container.
source <xs:element name="listCandidateResourcesResponse">
 
<xs:annotation>
   
<xs:documentation>Response element for the listCandidateResources operation.  Returns a list of candidate resources from the requested container.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:sequence>
     
<xs:element name="candidate" type="de:XmlResourceCandidate" minOccurs="0" maxOccurs="unbounded"/>
   
</xs:sequence>
   
<xs:attribute name="container-id" type="xs:long" use="required">
     
<xs:annotation>
       
<xs:documentation>Identifies the LDAP container from which the candidates were resolved.</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
   
<xs:attribute name="include" type="de:XmlCandidateChoice" default="ALL">
     
<xs:annotation>
       
<xs:documentation>Indicates what entries are be included in the collection of candidate entries.</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 listCandidateResourcesResponse/@container-id
type xs:long
properties
use required
annotation
documentation
Identifies the LDAP container from which the candidates were resolved.
source <xs:attribute name="container-id" type="xs:long" use="required">
 
<xs:annotation>
   
<xs:documentation>Identifies the LDAP container from which the candidates were resolved.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute listCandidateResourcesResponse/@include
type XmlCandidateChoice
properties
default ALL
facets
Kind Value Annotation
enumeration EXISTING
enumeration NON-EXISTING
enumeration ALL
enumeration INVALID
annotation
documentation
Indicates what entries are be included in the collection of candidate entries.
source <xs:attribute name="include" type="de:XmlCandidateChoice" default="ALL">
 
<xs:annotation>
   
<xs:documentation>Indicates what entries are be included in the collection of candidate entries.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute listCandidateResourcesResponse/@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 listCandidateResourcesResponse/@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 listCandidateResourcesResponse/candidate
diagram dir_directoryservice_diagrams/dir_directoryservice_p18.png
type XmlResourceCandidate
properties
minOcc 0
maxOcc unbounded
content complex
children secondary-ref
attributes
Name  Type  Use  Default  Fixed  Annotation
ldap-alias  xs:string  required      
documentation
The name (or alias) by which a configured LDAP connection shared resource is identified.

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.
ldap-dn  xs:string  required      
documentation
The full Distinguished Name (DN) of the LDAP entry identified by this element.
guid  xs:string  optional      
documentation
If the candidate is one for which a Resource already exists, the GUID of that existing resource is given.
name  xs:string  required      
documentation
The name of the existing resource, or the name that will be assigned (by default) to the resource created from this candidate entry.
error  XmlCandidateError  optional      
documentation
Read-only - Indicates that the candidate is invalid, and provides a coded explanation why. If this attribute is not present, the candidate is valid.
source <xs:element name="candidate" type="de:XmlResourceCandidate" minOccurs="0" maxOccurs="unbounded"/>


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