Box ArchiveでサポートされているAPI

ガイド Box Archive Box ArchiveでサポートされているAPI

Box ArchiveでサポートされているAPI

基本的なBox Archive APIを使用すると、アーカイブの作成、リスト取得、更新、削除を実行できますが、他のAPIを使用してアーカイブやそのコンテンツを操作することもできます。このようなAPIの詳細なリストについては、以下の表を参照してください。

これらのAPIを使用するには、アプリケーションでGCMスコープを有効にする必要があります。このスコープは、開発者コンソールでは使用できないため、カスタマーサポートに連絡して有効にする必要があります。

さらに、以下のAPIの中には、Box Archiveを適切に使用するために、カスタマーサポートに連絡して有効にする必要があるものもあります。カスタマーサポートに連絡する際は、これらのAPIを使用する予定のユーザーIDを明記してください。

APIエンドポイント	説明
`POST /archives`	アーカイブを作成します。
`GET /archives`	すべてのアーカイブのリストを取得します。
`PUT /archives/:id`	アーカイブを更新します。
`DELETE /archives/:id`	アーカイブを削除します。
`PUT /files/:id`	ファイルをアーカイブに追加したり、アーカイブから復元したり、アーカイブ内またはアーカイブ間で移動したりします。ファイルに対するその他の更新は許可されていません。有効にするには、カスタマーサポートに連絡する必要があります。
`PUT /folders/:id`	フォルダをアーカイブに追加したり、アーカイブから復元したり、アーカイブ内またはアーカイブ間で移動したりするほか、アーカイブ内のフォルダの名前や説明を変更します。フォルダに対するその他の更新は許可されていません。有効にするには、カスタマーサポートに連絡する必要があります。
`POST /files/content`	ファイルをアーカイブまたはアーカイブ内のフォルダにアップロードします。有効にするには、カスタマーサポートに連絡する必要があります。
`GET /files/:id/content`	ファイルをアーカイブまたはアーカイブ内のフォルダからダウンロードします。
`POST /zip_downloads`	アーカイブまたはアーカイブ内のフォルダのzipファイルをダウンロードします。
`POST /folders`	アーカイブ内にフォルダを作成します。有効にするには、カスタマーサポートに連絡する必要があります。
`GET /files/:id`	アーカイブ内のファイルの詳細を取得します。
`GET /folders/:id`	アーカイブまたはアーカイブ内のフォルダの詳細を取得します。
`GET /folders/:id/items`	アーカイブ内の項目またはアーカイブ内のフォルダにある項目のリストを取得します。
`POST /files/:id/copy`	ファイルをアーカイブにコピーします。
`POST /folders/:id/copy`	フォルダをアーカイブにコピーします。
`POST /files/:id/metadata/:scope/:template_key`	アーカイブ内のファイルに追加されるメタデータインスタンスを作成します。
`GET /files/:id/metadata/:scope/:template_key`	アーカイブ内のファイルに追加されるメタデータインスタンスを表示します。
`GET /files/:id/metadata`	アーカイブ内のファイルに追加されるすべてのメタデータインスタンスのリストを取得します。
`PUT /files/:id/metadata/:scope/:template_key`	アーカイブ内のファイルに追加されるメタデータインスタンスを更新します。
`DELETE /files/:id/metadata/:scope/:template_key`	アーカイブ内のファイルに追加されるメタデータインスタンスを削除します。
`POST securityClassification`	アーカイブ内のファイルの分類ラベルを作成します。
`GET securityClassification`	アーカイブ内のファイルの分類ラベルを表示します。
`PUT securityClassification`	アーカイブ内のファイルの分類ラベルを更新します。
`DELETE securityClassification`	アーカイブ内のファイルから分類ラベルを削除します。