DescendantControl 数据对象

DescendantControl 用于请求实体的后代。

DescendantControl 数据对象扩展自 HierarchyControl。它在 get API 的输入数据对象中用于请求实体的后代。如果 DescendantControl 添加到 get 操作中的数据对象,那么返回数据图中将会返回 Root 数据对象下的实体的后代。

由于 DescendantControl 扩展自 SearchControl,因此可指定 DescendantControl 中的搜索属性,以便仅返回满足搜索条件的后代。例如,可以添加带有值 entities[@xsi:type='PersonAccount'] 的属性表达式,以便仅返回实体类型为 PersonAccount 的后代。DescendantControl 还可以用于指定级别和要为后代返回的属性。

DescendantControl 数据对象的结构包含:
properties
是您希望从与搜索标准匹配的实体中返回的属性的列表。例如,希望获取市场营销部门的人员的 sn 和 givenName 属性。
searchBases
是一个搜索条件的列表,用于将搜索限制为列表中指定这些条件。
countLimit
用于指定由搜索操作返回的搜索结果的最大数量
timeLimit
如果概要文件存储库支持 timeLimit,那么此属性指定搜索的最长持续时间(以毫秒为单位)。
expression
是 XPath 格式的搜索表达式。
level
指定要返回的后代的级别。级别的缺省值为 1。请参阅下表。
此表概述后代级别的可能值:
表 1. DescendantControl 级别值
DescendantControl 级别 描述
1(缺省值) 仅返回子级。
任何正整数 返回指定级别的后代。例如,指定 2 将返回两个级别,子级和孙级。
0 返回所有后代。

XML 模式定义

以下是 DescendantControl 数据对象的 XML 模式定义。
<xsd:complexType name="DescendantControl">
		<xsd:complexContent>
			<xsd:extension base="HierarchyControl">
			</xsd:extension>
		</xsd:complexContent>
	</xsd:complexType>

样本数据对象

以下是样本 DescendantControl 数据对象,它返回所有后代及其 uid、cn、o 和 ou 属性(如存在):
<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>


使用条款 | 反馈