2.2.4.125 HierarchyMembersGetCriteria

  • Article

The HierarchyMembersGetCriteria complex type represents the criteria that are used by HierarchyMembersGet.

The following is the XML schema definition of the HierarchyMembersGetCriteria complex type.

 <xs:complexType name="HierarchyMembersGetCriteria">
   <xs:complexContent mixed="false">
     <xs:extension xmlns:q999="http://schemas.microsoft.com/sqlserver/masterdataservices/2009/09" base="q999:DataContractBase">
       <xs:sequence>
         <xs:element minOccurs="0" name="Ancestors" type="xs:boolean" />
         <xs:element minOccurs="0" name="HierarchyId" nillable="true" type="q999:Identifier">
           <xs:annotation>
             <xs:appinfo>
               <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false" />
             </xs:appinfo>
           </xs:annotation>
         </xs:element>
         <xs:element minOccurs="0" name="HierarchyType" type="q999:HierarchyType" />
         <xs:element minOccurs="0" name="MemberType" type="xs:int" />
         <xs:element minOccurs="0" name="ParentEntityId" nillable="true" type="q999:Identifier">
           <xs:annotation>
             <xs:appinfo>
               <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false" />
             </xs:appinfo>
           </xs:annotation>
         </xs:element>
         <xs:element minOccurs="0" name="ParentMember" nillable="true" type="xs:string" />
         <xs:element minOccurs="0" name="RowLimit" type="xs:int" />
         <xs:element minOccurs="0" name="SearchTerm" nillable="true" type="xs:string" />
         <xs:element minOccurs="0" name="UserId" nillable="true" type="q999:Identifier">
           <xs:annotation>
             <xs:appinfo>
               <DefaultValue xmlns="http://schemas.microsoft.com/2003/10/Serialization/" EmitDefaultValue="false" />
             </xs:appinfo>
           </xs:annotation>
         </xs:element>
         <xs:element name="ModelId" nillable="true" type="q999:Identifier" />
         <xs:element name="VersionId" nillable="true" type="q999:Identifier" />
       </xs:sequence>
     </xs:extension>
   </xs:complexContent>
 </xs:complexType>

Ancestors: Specifies a value that indicates whether the ancestors of the supplied member code will be retrieved.

HierarchyId: Specifies the hierarchy identifier being looked up.

HierarchyType: Specifies the type of hierarchy being queried.

MemberType: Specifies the type of members that are retrieved by the operation.

ModelId: Specifies the model identifier of the hierarchy being queried.

ParentEntityId: Specifies the identifier of the parent entity from which to get the members.

ParentMember: Specifies the member code from which to get the children.

RowLimit: Specifies the amount of rows retrieved by the operation.

SearchTerm: Specifies the criteria by which to search the hierarchy.

UserId: Specifies the user identifier for whom to get the members.

VersionId: Specifies the version identifier of the data being queried.