Box Developerドキュメント

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すべてのアーカイブのリストを取得します。
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 /files/:id/metadata/enterprise/securityClassification/6VMVochwUWoアーカイブ内のファイルに分類ラベルを作成します。
GET /files/:id/metadata/enterprise/securityClassification/6VMVochwUWoアーカイブ内のファイルの分類ラベルを表示します。
PUT /files/:id/metadata/enterprise/securityClassification/6VMVochwUWoアーカイブ内のファイルの分類ラベルを更新します。
DELETE /files/:id/metadata/enterprise/securityClassification/6VMVochwUWoアーカイブ内のファイルの分類ラベルを削除します。