Archives リソース - Box Dev Docs

Archive

アーカイブとは、冗長なコンテンツ、古くなったコンテンツ、または重要でないコンテンツの保存専用のフォルダです。アーカイブ内のコンテンツには、その所有者とコラボレータはアクセスできません。この機能を使用するには、Boxアプリケーションに対してGCMスコープをリクエストする必要があります。

属性と例

プロパティ	型	必須	説明
`id`	`string`	はい	アーカイブを表す一意の識別子。
`type`	`enum<string>`	はい	値は常に`archive`になります。使用可能なオプション: `archive`.
`name`	`string`	はい	アーカイブの名前。アーカイブ名には、印刷不可能なASCII文字、スラッシュ、バックスラッシュ (`/`、`\`) を含む名前、末尾にスペースを含む名前、`.`および`..`という名前は使用できないという制限が適用されます。
`size`	`integer`	はい	アーカイブのサイズ (バイト単位)。
`description`	`string`	いいえ	アーカイブの説明。 `null` を指定できます。
`owned_by`	`object`	いいえ	アーカイブを所有するユーザーについて説明している、アーカイブAPIレスポンスの部分。

例

{
  "id": "12345",
  "type": "archive",
  "name": "Archive",
  "size": 123456789,
  "description": "This is an archive for important documents.",
  "owned_by": {
    "id": "12345",
    "type": "user"
  }
}

Archives

アーカイブのリスト。

属性と例

プロパティ	型	必須	説明
`entries`	array of Archive	いいえ	各エントリがアーカイブオブジェクトを表しているリスト。
`limit`	`integer`	いいえ	これらのエントリで使用された制限値。許容される最大値を超えていない限り、クエリパラメータの`limit`と等しくなります。最大値はAPIによって異なります。
`next_marker`	`string`	いいえ	次の検索結果ページの開始場所のマーカー。 `null` を指定できます。

例

{
  "entries": [
    {
      "id": "12345",
      "type": "archive",
      "name": "Archive",
      "size": 123456789,
      "description": "This is an archive for important documents.",
      "owned_by": {
        "id": "12345",
        "type": "user"
      }
    }
  ],
  "limit": 1000,
  "next_marker": "JV9IRGZmieiBasejOG9yDCRNgd2ymoZIbjsxbJMjIs3kioVii"
}

​Archive

​Archives

Archive

Archives