Box Developerドキュメント
ログイン
最新バージョン

ファイルからメタデータインスタンスを削除

delete
https://api.box.com/2.0
/files/:file_id/metadata/:scope/:template_key

このエンドポイントはバージョン2024.0です。引き続き使用するために 変更は必要ありません。詳細については、 **Box APIのバージョン管理**を参照してください。

ファイルメタデータを削除します。

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

ファイルを表す一意の識別子。

ファイルIDを確認するには、ウェブアプリケーションでファイルにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/files/123の場合、file_idは123です。

stringパス内必須
global

メタデータテンプレートのスコープ。

次の値のいずれか1つ: global,enterprise

stringパス内必須
properties

メタデータテンプレートの名前。

レスポンス

none

メタデータが正常に削除された場合は空のレスポンスを返します。

application/jsonクライアントエラー

リクエストのパラメータが無効な場合に返されます。これは、scopeが無効な場合に発生する可能性があります。

application/jsonクライアントエラー

ファイルにメタデータテンプレートのインスタンスが適用されていない場合、またはユーザーがファイルにアクセスできない場合はエラーを返します。

  • instance_not_found - 指定されたscopeおよびtemplateKeyを持つメタデータテンプレートのインスタンスがこのファイルに見つかりませんでした。
  • not_found - ファイルが見つからなかったか、ユーザーがファイルにアクセスできません。
application/jsonクライアントエラー

メソッドが許可されなかった場合に返されます。

application/jsonクライアントエラー

予期しないクライアントエラー。

delete
ファイルからメタデータインスタンスを削除
このドキュメント内で一部のAPIを試せるようになりました。
ログイン

リクエストの例

Box SDKのバージョン戦略の詳細については、 **こちら**を確認してください。


cURL
curl -i -X DELETE "https://api.box.com/2.0/files/12345/metadata/enterprise_27335/blueprintTemplate" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
Node/TypeScript v10
await client.fileMetadata.deleteFileMetadataById(
  file.id,
  'enterprise' as DeleteFileMetadataByIdScope,
  templateKey,
);
Python v10
client.file_metadata.delete_file_metadata_by_id(
    file.id, DeleteFileMetadataByIdScope.ENTERPRISE, template_key
)
.NET v10
await client.FileMetadata.DeleteFileMetadataByIdAsync(fileId: file.Id, scope: DeleteFileMetadataByIdScope.Enterprise, templateKey: templateKey);
Swift v10
try await client.fileMetadata.deleteFileMetadataById(fileId: file.id, scope: DeleteFileMetadataByIdScope.global, templateKey: "properties")
Java v10
client.getFileMetadata().deleteFileMetadataById(file.getId(), DeleteFileMetadataByIdScope.ENTERPRISE, templateKey)
Java v5
BoxFile file = new BoxFile(api, "id");
file.deleteMetadata("myMetadataTemplate");
Python v4
client.file(file_id='11111').metadata(scope='enterprise', template='myMetadata').delete()
.NET v6
await client.MetadataManager.DeleteFileMetadataAsync("11111", "enterprise", "marketingCollateral");
Node v4
client.files.deleteMetadata('67890', client.metadata.scopes.GLOBAL, client.metadata.templates.PROPERTIES)
	.then(() => {
		// removal succeeded — no value returned
	});;