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

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

delete
https://api.box.com/2.0
/folders/:folder_id/metadata/:scope/:template_key

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

フォルダのメタデータを削除します。

関連するガイド

リクエスト

bearer [ACCESS_TOKEN]
application/json

パスパラメータ

stringパス内必須
12345

フォルダを表す一意の識別子。

フォルダ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クライアントエラー

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

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

リクエストの例

cURL
curl -i -X DELETE "https://api.box.com/2.0/folders/4353455/metadata/enterprise_27335/blueprintTemplate" \
     -H "authorization: Bearer <ACCESS_TOKEN>"
TypeScript Gen
await client.folderMetadata.deleteFolderMetadataById(
  folder.id,
  'global' as DeleteFolderMetadataByIdScope,
  'properties',
);
Python Gen
client.folder_metadata.delete_folder_metadata_by_id(
    folder.id, DeleteFolderMetadataByIdScope.GLOBAL, "properties"
)
.NET Gen
await client.FolderMetadata.DeleteFolderMetadataByIdAsync(folderId: folder.Id, scope: DeleteFolderMetadataByIdScope.Global, templateKey: "properties");
Java
BoxFolder folder = new BoxFolder(api, "id");
folder.deleteMetadata("myMetadataTemplate");
Python
client.folder(folder_id='11111').metadata(scope='enterprise', template='myMetadata').delete()
.NET
await client.MetadataManager.DeleteFolderMetadataAsync("11111", "enterprise", "marketingCollateral");
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")
}