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

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

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

リクエスト

Bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

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

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

stringパス内必須
global

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

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

stringパス内必須
properties

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

レスポンス

none

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

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

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

  • instance_not_found - 指定されたscopetemplateKeyのメタデータテンプレートのインスタンスがこのファイルに見つからなかった場合に返されます。
  • not_found - ファイルが見つからなかったか、ユーザーがファイルにアクセスできない場合に返されます。

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

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

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

リクエストの例

cURL
curl -i -X DELETE "https://api.box.com/2.0/files/12345/metadata/enterprise_27335/blueprintTemplate" \
     -H "Authorization: Bearer <ACCESS_TOKEN>"
.NET
await client.MetadataManager.DeleteFileMetadataAsync("11111", "enterprise", "marketingCollateral");
Java
BoxFile file = new BoxFile(api, "id");
file.deleteMetadata("myMetadataTemplate");
Python
client.file(file_id='11111').metadata(scope='enterprise', template='myMetadata').delete()
Node
client.files.deleteMetadata('67890', client.metadata.scopes.GLOBAL, client.metadata.templates.PROPERTIES)
	.then(() => {
		// removal succeeded — no value returned
	});;
iOS
client.metadata.delete(
    forFileWithId: "11111",
    scope: "enterprise",
    templateKey: "personnelRecord"
) { (result: Result<Void, BoxSDKError>) in
    guard case .success = result {
        print("Error deleting metadata instance")
        return
    }

    print("Metadata instance deleted")
}