リスト API の入力 XML の OrderBy 要素でのソート

リスト API の入力 XML は、OrderBy 要素に基づくソートをサポートしています。

照会を形成する手順は、以下のとおりです。

任意のリスト API のカスタム入力 XML を編集し、OrderBy 要素を追加します。 Attribute 子要素を追加し、Name 属性で結果のソートに使用するフィールドに基づいてフィールドの名前を指定します。

OrderBy 要素は、属性の並べ替えに昇順と降順の両方をサポートします。デフォルトでは、結果は昇順にソートされます。結果を降順でソートする場合、Desc 属性を Attribute 要素に追加し、これを Y に設定します。

OrderBy 要素を使用して、ネスト化ソートも実行できます。

orderBy 要素を備えた GetOrganizationList API 入力 XML

以下の例では、組織のリストを返し、結果を OrganizationName 属性でソートする入力 XML の一部を示しています。

<Organization IgnoreOrdering="N" MaximumRecords="5000"> 
  <OrderBy> 
     <Attribute Name="OrganizationName"/> 
   </OrderBy> 
</Organization>

ネスト化 orderBy 要素を備えた GetOrganizationList API 入力 XML

以下の例では、組織のリストを返し、結果を OrganizationName 属性および LocaleCode 属性でソートする入力 XML の一部を示しています。

<Organization IgnoreOrdering="N" MaximumRecords="5000"> 
   <OrderBy> 
     <Attribute Name="OrganizationName"/> 
     <Attribute Name="LocaleCode"/> 
    </OrderBy> 
</Organization>

orderBy 要素および desc 属性を備えた GetOrganizationList API 入力 XML

以下の例では、組織のリストを返し、結果を OrganizationName 属性で降順でソートする入力 XML の一部を示しています。

<Organization IgnoreOrdering="N" MaximumRecords="5000"> 
   <OrderBy> 
      <Attribute Name="OrganizationName" Desc="Y"/> 
   </OrderBy> 
</Organization>