complexType XmlLdapEntity
diagram de-orgmodel-service_diagrams/de-orgmodel-service_p254.png
namespace http://api.de.n2.tibco.com
children LdapReference
used by
elements XmlEntityMapping/create XmlEntityInstantiatedList/resource
complexType XmlResourceDetail
attributes
Name  Type  Use  Default  Fixed  Annotation
resource-type  ResourceType    HUMAN    
documentation
Specifies the type of an organization model resource entity. One of:
- HUMAN
- DURABLE
- CONSUMABLE
guid  xs:string  optional      
documentation
Unique identifier of the resource.
name  xs:string  optional      
documentation
Descriptive name of the resource.
startDate  xs:dateTime  optional      
documentation
Date/time at which the entity becomes available.
endDate  xs:dateTime  optional      
documentation
Date/time at which the entity becomes unavailable.
invalid  xs:boolean        
documentation
Boolean value indicating whether the resource is valid (FALSE) or invalid (TRUE).

A resource may be invalid if, for example, the resource has been removed from the LDAP source, or if all of the data cannot be returned from the LDAP source. Check the invalidReason attribute for more details.
invalidReason  xs:string        
documentation
Description of the reason why this resource is invalid.
annotation
documentation
Organization model resource entity identifier (either its GUID or LDAP reference).

If the resource already exists the GUID will be available. If the resource does not exist, the LdapReference will be present and will provide the necessary information to derive an organization model resource from an LDAP entry or entries.
source <xs:complexType name="XmlLdapEntity">
 
<xs:annotation>
   
<xs:documentation>Organization model resource entity identifier (either its GUID or LDAP reference).

If the resource already exists the GUID will be available. If the resource does not exist, the LdapReference will be present and will provide the necessary information to derive an organization model resource from an LDAP entry or entries.
</xs:documentation>
 
</xs:annotation>
 
<xs:sequence>
   
<xs:element name="LdapReference" type="XmlLdapReference" minOccurs="0">
     
<xs:annotation>
       
<xs:documentation>Details of the LDAP entries from which the organization model resource is derived.</xs:documentation>
     
</xs:annotation>
   
</xs:element>
 
</xs:sequence>
 
<xs:attribute name="resource-type" type="ResourceType" default="HUMAN">
   
<xs:annotation>
     
<xs:documentation>Specifies the type of an organization model resource entity. One of:
- HUMAN
- DURABLE
- CONSUMABLE
</xs:documentation>
   
</xs:annotation>
 
</xs:attribute>
 
<xs:attribute name="guid" type="xs:string" use="optional">
   
<xs:annotation>
     
<xs:documentation>Unique identifier of the resource.</xs:documentation>
   
</xs:annotation>
 
</xs:attribute>
 
<xs:attribute name="name" type="xs:string" use="optional">
   
<xs:annotation>
     
<xs:documentation>Descriptive name of the resource.</xs:documentation>
   
</xs:annotation>
 
</xs:attribute>
 
<xs:attributeGroup ref="XmlDuration">
   
<xs:annotation>
     
<xs:documentation>Identifies a duration of time, expressed as a start and end date/time. Both values are optional but, if an end date is given, a start date must also be provided.</xs:documentation>
   
</xs:annotation>
 
</xs:attributeGroup>
 
<xs:attribute name="invalid" type="xs:boolean">
   
<xs:annotation>
     
<xs:documentation>Boolean value indicating whether the resource is valid (FALSE) or invalid (TRUE).

A resource may be invalid if, for example, the resource has been removed from the LDAP source, or if all of the data cannot be returned from the LDAP source. Check the invalidReason attribute for more details.
</xs:documentation>
   
</xs:annotation>
 
</xs:attribute>
 
<xs:attribute name="invalidReason" type="xs:string">
   
<xs:annotation>
     
<xs:documentation>Description of the reason why this resource is invalid.</xs:documentation>
   
</xs:annotation>
 
</xs:attribute>
</xs:complexType>

attribute XmlLdapEntity/@resource-type
type ResourceType
properties
default HUMAN
facets
Kind Value Annotation
enumeration DURABLE
enumeration CONSUMABLE
enumeration HUMAN
annotation
documentation
Specifies the type of an organization model resource entity. One of:
- HUMAN
- DURABLE
- CONSUMABLE
source <xs:attribute name="resource-type" type="ResourceType" default="HUMAN">
 
<xs:annotation>
   
<xs:documentation>Specifies the type of an organization model resource entity. One of:
- HUMAN
- DURABLE
- CONSUMABLE
</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute XmlLdapEntity/@guid
type xs:string
properties
use optional
annotation
documentation
Unique identifier of the resource.
source <xs:attribute name="guid" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>Unique identifier of the resource.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute XmlLdapEntity/@name
type xs:string
properties
use optional
annotation
documentation
Descriptive name of the resource.
source <xs:attribute name="name" type="xs:string" use="optional">
 
<xs:annotation>
   
<xs:documentation>Descriptive name of the resource.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute XmlLdapEntity/@invalid
type xs:boolean
annotation
documentation
Boolean value indicating whether the resource is valid (FALSE) or invalid (TRUE).

A resource may be invalid if, for example, the resource has been removed from the LDAP source, or if all of the data cannot be returned from the LDAP source. Check the invalidReason attribute for more details.
source <xs:attribute name="invalid" type="xs:boolean">
 
<xs:annotation>
   
<xs:documentation>Boolean value indicating whether the resource is valid (FALSE) or invalid (TRUE).

A resource may be invalid if, for example, the resource has been removed from the LDAP source, or if all of the data cannot be returned from the LDAP source. Check the invalidReason attribute for more details.
</xs:documentation>
 
</xs:annotation>
</xs:attribute>

attribute XmlLdapEntity/@invalidReason
type xs:string
annotation
documentation
Description of the reason why this resource is invalid.
source <xs:attribute name="invalidReason" type="xs:string">
 
<xs:annotation>
   
<xs:documentation>Description of the reason why this resource is invalid.</xs:documentation>
 
</xs:annotation>
</xs:attribute>

element XmlLdapEntity/LdapReference
diagram de-orgmodel-service_diagrams/de-orgmodel-service_p255.png
type XmlLdapReference
properties
minOcc 0
maxOcc 1
content complex
children SecondaryLdapEntry
attributes
Name  Type  Use  Default  Fixed  Annotation
container-id  xs:long    0    
documentation
Identifier of the LDAP Container in which the referenced LDAP connections are defined, and from which this XmlLdapReference was constructed.
container-name  xs:string  optional      
documentation
Name of the LDAP Container in which the referenced LDAP connections are defined, and from which this XmlLdapReference was constructed.
ldap-alias  xs:string  required      
documentation
Alias by which the LDAP connection is registered within Directory Engine. Used to look up that connection so that the attribute's value can be read.       
ldap-dn  xs:string  required      
documentation
Distinguished Name (DN) that uniquely identifies an LDAP entry. Used to look up that entry so that the attribute values can be read. 
annotation
documentation
Details of the LDAP entries from which the organization model resource is derived.
source <xs:element name="LdapReference" type="XmlLdapReference" minOccurs="0">
 
<xs:annotation>
   
<xs:documentation>Details of the LDAP entries from which the organization model resource is derived.</xs:documentation>
 
</xs:annotation>
</xs:element>


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