Datenobjekt "DescendantControl"

"DescendantControl" wird verwendet, um die untergeordneten Elemente einer Entität abzufragen.

Das Datenobjekt "DescendantControl" ist eine Erweiterung von "HierarchyControl". Es wird im Eingabedatenobjekt der API "get" verwendet, um die untergeordneten Elemente einer Entität abzufragen. Wenn "DescendantControl" dem Datenobjekt in einer Operation "get" hinzugefügt wird, werden die untergeordneten Elemente der Entitäten unter dem Datenobjekt "Root" im zurückgegebenen Datengraph zurückgegeben.

Da "DescendantControl" eine Erweiterung von "SearchControl" ist, können Sie die Suchmerkmale in "DescendantControl" so angeben, dass nur die untergeordneten Elemente zurückgegeben werden, die die Suchkriterien erfüllen. Beispiel: Sie können das Merkmal "expression" mit dem Wert "entities[@xsi:type="PersonAccount"]" hinzufügen, so dass nur die untergeordneten Elemente zurückgeben werden, die den Entitätstyp "PersonAccount" besitzen. Das Datenobjekt "DescendantControl" kann auch verwendet werden, um die Ebene und die Merkmale anzugeben, die für die übergeordneten Elemente zurückgegeben werden sollen.

Die Struktur des Datenobjekts "DescendantControl" hat folgende Bestandteile:
properties
Dies ist eine Liste der Attribute, die Sie von den Entitäten abrufen möchten und die mit den Suchkriterien übereinstimmen sollen. Beispiel: Sie möchten die Attribute "sn" (Familienname) und "givenName" (Vorname) für eine bestimmte Person im Vertrieb abrufen.
searchBases
Eine Liste der verwendeten Suchbasen, um die Suche auf die in der Liste angegebenen Suchbasen zu beschränken.
countLimit
Gibt die maximale Anzahl von Suchergebnissen an, die durch die Suchoperation zurückgegeben werden sollen.
timeLimit
Wenn das Profil-Repository "timeLimit" unterstützt, gibt dieser Parameter die maximale Suchdauer in Millisekunden an.
expression
Ist der Suchausdruck im Format XPath.
level
Gibt die Ebene der untergeordneten Elemente an, die zurückgegeben werden sollen. Der Standardwert für "level" ist 1. Siehe auch die folgende Tabelle.
In dieser Tabelle werden die gültigen Werte für die Ebene der untergeordneten Elemente dargestellt:
Tabelle 1. "DescendantControl" - Ebenen und Werte
DescendantControl-Ebene Beschreibung
1 (Standard) Gibt nur untergeordnete Elemente zurück.
Jede positive ganze Zahl Gibt die angegebene Ebene der untergeordneten Elemente zurück. Beispiel: Wenn Sie "2" angeben, werden 2 Ebenen zurückgegeben: die untergeordneten Elemente und die diesen untergeordneten Elemente (Enkelelemente).
0 Gibt alle untergeordneten Elemente zurück.

XML-Schemadefinition

Nachfolgend finden Sie die XML-Schemadefinition für das Datenobjekt "DescendantControl".
<xsd:complexType name="DescendantControl">
		<xsd:complexContent>
						<xsd:extension base="HierarchyControl">
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>

Beispieldatenobjekt

Im Folgenden sehen Sie ein Beispiel für das Datenobjekt "DescendantControl", das sämtliche untergeordneten Elemente und deren Merkmale "uid", "cn", "o" und "ou" zurückgibt, falls vorhanden:
<wim:controls xsi:type="wim:DescendantControl" level="0">
      <wim:properties>uid</wim:properties>
      <wim:properties>cn</wim:properties>
      <wim:properties>o</wim:properties>
      <wim:properties>ou</wim:properties>
  </wim:controls>


Rechtliche Hinweise | Feedback