AncestorControl DataObject

AncestorControl permet de lancer une requête sur les ancêtres d'une entité.

L'objet de données AncestorControl est une extension de HierarchyControl. Il est utilisé dans l'objet de données d'entrée de l'API d'extraction (get) pour lancer une requête sur les ancêtres d'une entité. Si vous ajoutez AncestorControl à l'objet de données dans une opération d'extraction, les ancêtres des entités sous l'objet de données racine (Root DataObject) sont renvoyés dans l'objet de données retourné.

AncestorControl étant une extension de SearchControl, vous pouvez indiquer des propriétés de recherche dans AncestorControl pour obtenir uniquement les ancêtres qui répondent aux critères de recherche. AncestorControl permet également d'indiquer le niveau et les propriétés des ancêtres à retourner.

La structure d'un graphique de données d'un objet de données AncestorControl se compose des éléments suivants :
propriétés
liste des attributs à retourner des entités qui répondent aux critères de recherche. Par exemple, vous souhaitez obtenir les attributs sn et givenName des personnes du service marketing.
searchBases
liste de bases de recherche permettant de limiter la recherche aux bases recensées.
countLimit
nombre maximal de résultats renvoyés par l'opération de recherche.
timeLimit
Si le référentiel de profil prend en charge le délai, il indique la durée maximale de recherche en milliseconde.
expression
expression de recherche au format XPath.
level
niveau des ancêtres à retourner. Par défaut, la valeur de niveau est définie sur 1. Voir le tableau suivant.
Ce tableau répertorie les valeurs possibles du niveau des ancêtres :
Tableau 1. Valeurs du niveau AncestorControl
Niveau AncestorControl Description
1 (par défaut) Permet de retourner uniquement les parents.
Tout nombre entier positif Permet de retourner le niveau indiqué d'ancêtres. Par exemple, si vous indiquez 2, deux niveaux sont retournés, parent et grand-parent.
0 Permet de retourner tous les ancêtres jusqu'au noeud de virtual member manager.

Définition de schéma XML

Vous trouverez ci-dessous la définition du schéma XML pour l'objet de données AncestorControl.
<xsd:complexType name="AncestorControl">
		<xsd:complexContent>
			<xsd:extension base="HierarchyControl">
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>

Objet de données exemple

Vous trouverez ci-dessous un exemple d'objet de données AncestorControl qui renvoie tous les ancêtres et leurs propriétés uid, cn, o et ou, le cas échéant :
<wim:controls xsi:type="wim:AncestorControl" level="0">
    <wim:properties>uid</wim:properties>
    <wim:properties>cn</wim:properties>
    <wim:properties>o</wim:properties>
    <wim:properties>ou</wim:properties>
 </wim:controls>


Conditions d'utilisation | Commentaires