フォルダからメタデータインスタンスを削除
delete
https://api.box.com/2.0
/folders/:folder_id/metadata/:scope/:template_key
フォルダのメタデータを削除します。
リクエスト
application/json
パスパラメータ
stringパス内必須
0フォルダを表す一意の識別子。
フォルダIDを確認するには、ウェブアプリケーションでこのフォルダにアクセスして、URLからIDをコピーします。たとえば、URLがhttps://*.app.box.com/folder/123の場合、folder_idは123です。
Boxアカウントのルートフォルダは常にID 0で表されます。
stringパス内必須
globalメタデータテンプレートのスコープ
次の値のいずれか1つ: global,enterprise
stringパス内必須
propertiesメタデータテンプレートの名前
レスポンス
none
メタデータが正常に削除された場合は空の応答を返します。
application/jsonクライアントエラー
リクエストのパラメータが無効な場合に返されます。これは、scopeが無効な場合に発生する可能性があります。
application/jsonクライアントエラー
フォルダにメタデータテンプレートのインスタンスが適用されていない場合、またはユーザーがフォルダにアクセスできない場合はエラーを返します。
instance_not_found- 指定されたscopeとtemplateKeyのメタデータテンプレートのインスタンスがこのフォルダに見つからなかった場合に返されます。not_found- フォルダが見つからなかったか、ユーザーがフォルダにアクセスできない場合に返されます。
application/jsonクライアントエラー
メソッドが許可されなかった場合に返されます。これは、フォルダIDが無効であるか、IDが0のルートフォルダである場合によく発生します。
application/jsonクライアントエラー
予期しないクライアントエラー。
リクエストの例
cURL
curl -X DELETE https://api.box.com/2.0/folders/4353455/metadata/enterprise_27335/blueprintTemplate \
-H 'Authorization: Bearer <ACCESS_TOKEN>'.NET
await client.MetadataManager.DeleteFolderMetadataAsync("11111", "enterprise", "marketingCollateral");Java
BoxFolder folder = new BoxFolder(api, "id");
folder.deleteMetadata("myMetadataTemplate");Python
client.folder(folder_id='11111').metadata(scope='enterprise', template='myMetadata').delete()Node
client.folders.deleteMetadata('67890', client.metadata.scopes.GLOBAL, client.metadata.templates.PROPERTIES)
.then(() => {
// removal succeeded — no value returned
});iOS
client.metadata.delete(
forFolderWithId: "22222",
scope: "enterprise",
templateKey: "personnelRecord"
) { (result: Result<Void, BoxSDKError>) in
guard case .success = result {
print("Error deleting metadata instance")
return
}
print("Metadata instance deleted")
}