Join BoxWorks 2024 to discover what's possible with content and AI!
Register now!Remove metadata instance from file
Deletes a piece of file metadata.
Request
Path Parameters
12345The unique identifier that represents a file.
The ID for any file can be determined
by visiting a file in the web application
and copying the ID from the URL. For example,
for the URL https://*.app.box.com/files/123
the file_id is 123.
globalThe scope of the metadata template
Value is one of global,enterprise
propertiesThe name of the metadata template
Response
Returns an empty response when the metadata is successfully deleted.
Returned when the request parameters are not valid. This may happen of the
scope is not valid.
Returns an error when the file does not have an instance of the metadata template applied to it, or when the user does not have access to the file.
instance_not_found- An instance of the metadata template with the givenscopeandtemplateKeywas not found on this file.not_found- The file was not found, or the user does not have access to the file.
Returned when the method was not allowed.
An unexpected client error.
Request Example
curl -i -X DELETE "https://api.box.com/2.0/files/12345/metadata/enterprise_27335/blueprintTemplate" \
-H "authorization: Bearer <ACCESS_TOKEN>"await client.fileMetadata.deleteFileMetadataById(
file.id,
'enterprise' as DeleteFileMetadataByIdScope,
templateKey,
);client.file_metadata.delete_file_metadata_by_id(
file.id, DeleteFileMetadataByIdScope.ENTERPRISE.value, template_key
)await client.FileMetadata.DeleteFileMetadataByIdAsync(fileId: file.Id, scope: DeleteFileMetadataByIdScope.Enterprise, templateKey: templateKey);try await client.fileMetadata.deleteFileMetadataById(fileId: file.id, scope: DeleteFileMetadataByIdScope.global, templateKey: "properties")BoxFile file = new BoxFile(api, "id");
file.deleteMetadata("myMetadataTemplate");client.file(file_id='11111').metadata(scope='enterprise', template='myMetadata').delete()await client.MetadataManager.DeleteFileMetadataAsync("11111", "enterprise", "marketingCollateral");client.files.deleteMetadata('67890', client.metadata.scopes.GLOBAL, client.metadata.templates.PROPERTIES)
.then(() => {
// removal succeeded — no value returned
});;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")
}