応答の並べ替え

ガイドAPI呼び出し応答の並べ替え

応答の並べ替え

APIから項目のコレクションが返される場合は、API応答の並べ替えがサポートされることがよくあります。

sortおよびdirectionクエリパラメータを使用すると、昇順または降順のいずれかでコレクションを並べ替えることができます。

curl https://api.box.com/2.0/folders/0/items?sort=size&direction=DESC \
    -H "authorization: Bearer ACCESS_TOKEN"

コレクションを返すすべてのAPIエンドポイントが並べ替えをサポートしているわけではありません。特にマーカーベースのページ割りを使用するエンドポイントでは、結果の並べ替えがサポートされないことがよくあります。

並べ替え基準

並べ替えの基準となるフィールドはsortクエリパラメータによって定義されます。この値に使用できるオプションについては、APIエンドポイントのドキュメントを確認してください。

一部のAPIでは、sortフィールドが項目の並べ替えの2番目の基準になっています。たとえば、GET /folders/:id/itemsエンドポイントの場合、結果は常に、まずその種類で並べ替えられてから、他の基準で並べ替えられます。

並べ替えの方向

並べ替えの方向では、ASC (昇順の場合)とDESC (降順の場合)という2つの値がサポートされます。