element listCandidateResources
diagram dir_directoryservice_diagrams/dir_directoryservice_p16.png
namespace http://directory.api.de.bpm.tibco.com
properties
content complex
attributes
Name  Type  Use  Default  Fixed  Annotation
container-id  xs:long  required      
documentation
Identifies the LDAP container from which the candidates are to be resolved.
include  XmlCandidateChoice    ALL    
documentation
Determines what entries should be included in the response.
page-size  xs:int        
documentation
Requested page size for paged result sets. If not specified then paging will not be used. To be specified on every paging request.
bookmark  xs:string        
documentation
Opaque marker for progress through a paged result set. Not specified on the first paging request. Only specified on subsequent paging requests. Content must be Base64 encoded.
annotation
documentation
Request element for the listCandidateResources operation. Lists the candidate resources (including existing eesources) from the identified LDAP container. The entries in the response are suitable to be passed to the createResource operation.
source <xs:element name="listCandidateResources">
 
<xs:annotation>
   
<xs:documentation>Request element for the listCandidateResources operation. Lists the candidate resources (including existing eesources) from the identified LDAP container. The entries in the response are suitable to be passed to the createResource operation.</xs:documentation>
 
</xs:annotation>
 
<xs:complexType>
   
<xs:attribute name="container-id" type="xs:long" use="required">
     
<xs:annotation>
       
<xs:documentation>Identifies the LDAP container from which the candidates are to be resolved.</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
   
<xs:attribute name="include" type="de:XmlCandidateChoice" default="ALL">
     
<xs:annotation>
       
<xs:documentation>Determines what entries should be included in the response.</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
   
<xs:attribute name="page-size" type="xs:int">
     
<xs:annotation>
       
<xs:documentation>Requested page size for paged result sets. If not specified then paging will not be used. To be specified on every paging request.</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. Not specified on the first paging request. Only specified on subsequent paging requests. Content must be Base64 encoded.</xs:documentation>
     
</xs:annotation>
   
</xs:attribute>
 
</xs:complexType>
</xs:element>

attribute listCandidateResources/@container-id
type xs:long
properties
use required
annotation
documentation
Identifies the LDAP container from which the candidates are to be resolved.
source <xs:attribute name="container-id" type="xs:long" use="required">
 
<xs:annotation>
   
<xs:documentation>Identifies the LDAP container from which the candidates are to be resolved.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute listCandidateResources/@include
type XmlCandidateChoice
properties
default ALL
facets
Kind Value Annotation
enumeration EXISTING
enumeration NON-EXISTING
enumeration ALL
enumeration INVALID
annotation
documentation
Determines what entries should be included in the response.
source <xs:attribute name="include" type="de:XmlCandidateChoice" default="ALL">
 
<xs:annotation>
   
<xs:documentation>Determines what entries should be included in the response.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute listCandidateResources/@page-size
type xs:int
annotation
documentation
Requested page size for paged result sets. If not specified then paging will not be used. To be specified on every paging request.
source <xs:attribute name="page-size" type="xs:int">
 
<xs:annotation>
   
<xs:documentation>Requested page size for paged result sets. If not specified then paging will not be used. To be specified on every paging request.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute listCandidateResources/@bookmark
type xs:string
annotation
documentation
Opaque marker for progress through a paged result set. Not specified on the first paging request. Only specified on subsequent paging requests. Content must be Base64 encoded.
source <xs:attribute name="bookmark" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>Opaque marker for progress through a paged result set. Not specified on the first paging request. Only specified on subsequent paging requests. Content must be Base64 encoded.</xs:documentation>
 
</xs:annotation>
</xs:attribute>


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