Collections リソース

Collection

ファイルやフォルダなどの項目のコレクション。現時点で利用可能なコレクションは、favoritesコレクションのみです。コレクションのコンテンツは、フォルダのコンテンツと同じ方法で調べることができます。

属性と例

プロパティ	型	必須	説明
`id`	`string`	いいえ	このコレクションの一意の識別子。
`type`	`enum<string>`	いいえ	値は常に`collection`になります。使用可能なオプション: `collection`.
`name`	`enum<string>`	いいえ	コレクションの名前。使用可能なオプション: `Favorites`.
`collection_type`	`enum<string>`	いいえ	コレクションのタイプ。これは、コレクションの視覚効果を適切に決定するために使用されます。使用可能なオプション: `favorites`.

例

{
  "id": "11446498",
  "type": "collection",
  "name": "Favorites",
  "collection_type": "favorites"
}

Collections

コレクションのリスト。

属性と例

プロパティ	型	必須	説明
`total_count`	`integer`	いいえ	コレクション全体の最後のエントリのオフセットに1を加算した値。コレクション内のエントリの合計数は、`total_count`よりも少ない場合があります。このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。
`limit`	`integer`	いいえ	これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。
`offset`	`integer`	いいえ	このセットに含まれる最初のエントリのゼロから始まるオフセット。これは、`offset`クエリパラメータと同じになります。このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。
`order`	array of `object`	いいえ	項目が返される順序。このフィールドは、オフセットベースのページネーションを使用する呼び出しのみで返されます。マーカーベースでページネーションされたAPIでは、このフィールドは省略されます。
`entries`	array of Collection	いいえ	コレクションのリスト。

例

{
  "total_count": 5000,
  "limit": 1000,
  "offset": 2000,
  "order": [
    {
      "by": "type",
      "direction": "ASC"
    }
  ],
  "entries": [
    {
      "id": "11446498",
      "type": "collection",
      "name": "Favorites",
      "collection_type": "favorites"
    }
  ]
}

​Collection

​Collections

Collection

Collections