box-api - フォルダー アイテムの取得 API 呼び出しの順序

Question

get folder items API 呼び出しを使用しています。テストから、順序が最初にフォルダー、次にアルファベット順に表示されることがわかります。

この呼び出しは常にその順序でアイテムを返すことが保証されていますか?

Answer 1

Box Platform チーム メンバー ... コレクション エンドポイントのいずれかによって返される結果の順序は、パブリック コントラクトの一部とは見なされず、変更される可能性があります。少なくともGET /folders/id/itemsの場合、JSON 応答にはorder、応答の順序を示す配列が含まれます。

{
    "total_count": 6,
    "entries": [
        {
            "type": "folder",
            "id": "192429928",
            "sequence_id": "1",
            "etag": "1",
            "name": "Lebron and Friends"
        },
        {
            "type": "folder",
            "id": "192429929",
            "sequence_id": "1",
            "etag": "1",
            "name": "Stephen Curry Three Pointers"
        },
        {
            "type": "file",
            "id": "818853864",
            "sequence_id": "0",
            "etag": "0",
            "name": "Heat.jpg"
        },
        {
            "type": "file",
            "id": "818853862",
            "sequence_id": "0",
            "etag": "0",
            "name": "Warriors.jpg"
        }
    ],
    "offset": 0,
    "limit": 4,
    "order": [
        {
            "by": "type",
            "direction": "ASC"
        },
        {
            "by": "name",
            "direction": "ASC"
        }
    ]
}

この応答には Web リンクも含まれる場合があることに注意してください。

アプリが特定の方法で並べ替えられるアイテムのリストに依存している場合は、クライアントでの並べ替えをお勧めします。