DescendantControl は、エンティティーの子孫を要求するために使用します。
DescendantControl DataObject は HierarchyControl から拡張されます。 このデータ・オブジェクトは、エンティティーの子孫を要求するために、get API の入力データ・オブジェクトで使用されます。 DescendantControl を get 操作のデータ・オブジェクトに追加すると、Root DataObject の下にあるエンティティーの子孫が戻りデータ・グラフで戻されます。
DescendantControl は SearchControl から拡張されるため、DescendantControl に検索プロパティーを指定して、検索条件を満たす子孫のみを戻すようにすることができます。 例えば、値 entities[@xsi:type='PersonAccount'] を含むプロパティー expression を追加すれば、PersonAccount エンティティー・タイプの子孫のみを戻すことができます。 DescendantControl はまた、子孫に対して、戻すレベルとプロパティーを指定するためにも使用できます。
DescendantControl level | 説明 |
---|---|
1 (デフォルト) | 子のみを戻します。 |
任意の正整数 | 指定されたレベルの子孫を戻します。 例えば、2 を指定すると、2 つのレベル (子と孫) が戻されます。 |
0 | すべての子孫を戻します。 |
<xsd:complexType name="DescendantControl">
<xsd:complexContent>
<xsd:extension base="HierarchyControl">
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
<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>