IService.MetadataDelete(MetadataDeleteRequest) Method

public:
 Microsoft::MasterDataServices::Services::MessageContracts::MetadataDeleteResponse ^ MetadataDelete(Microsoft::MasterDataServices::Services::MessageContracts::MetadataDeleteRequest ^ request);

[System.ServiceModel.FaultContract(typeof(Microsoft.MasterDataServices.Services.DataContracts.EditionExpiredMessage))]
[System.ServiceModel.FaultContract(typeof(Microsoft.MasterDataServices.Services.DataContracts.SkuNotSupportedMessage))]
[System.ServiceModel.OperationContract]
public Microsoft.MasterDataServices.Services.MessageContracts.MetadataDeleteResponse MetadataDelete (Microsoft.MasterDataServices.Services.MessageContracts.MetadataDeleteRequest request);

[<System.ServiceModel.FaultContract(typeof(Microsoft.MasterDataServices.Services.DataContracts.EditionExpiredMessage))>]
[<System.ServiceModel.FaultContract(typeof(Microsoft.MasterDataServices.Services.DataContracts.SkuNotSupportedMessage))>]
[<System.ServiceModel.OperationContract>]
abstract member MetadataDelete : Microsoft.MasterDataServices.Services.MessageContracts.MetadataDeleteRequest -> Microsoft.MasterDataServices.Services.MessageContracts.MetadataDeleteResponse

Public Function MetadataDelete (request As MetadataDeleteRequest) As MetadataDeleteResponse

Parameters

Returns

Attributes

FaultContractAttribute OperationContractAttribute

Remarks

The MetadataDelete(MetadataDeleteRequest) operation deletes metadata objects from an MDS repository. The request's Metadata element identifies objects to be deleted. One or more objects may be specified within a single request. The objects that are specified may be of the same or multiple object types. Objects are located by GUIDs only; names are ignored.

This operation issues individual Delete operations for each item. The failure or inability to delete one item does not affect the attempt to delete or the successful deletion of other items that are explicitly included in the request. Multiple calls for individual items may be implemented if alternative error-handling is required.

Deletions of some metadata components are cascading and automatically delete their child components. This occurs in cases in which the components are fully dependent on the deleted component and therefore have no further usefulness without the deleted component.

The following events occur during a model Delete operation:

• All related metadata subcomponents (such as entities, attributes, hierarchies, and versions) are deleted.
• Associated business rules are deleted.
• Associated model and hierarchy member security permissions are deleted.

The following events occur during an entity Delete operation:

• The related metadata sub-components (such as attributes, attribute groups, and explicit hierarchies) are deleted.
• Associated business rules are deleted.
• Associated model and hierarchy member security permissions (such as model security permissions assigned at the entity component or below) are deleted.

An error occurs when an attempt is made to delete a component when one or more of the following conditions are true:

• An entity, attribute, or explicit hierarchy is deleted when used by a derived hierarchy.
• An attribute is deleted when a related business rule exists.
• An explicit hierarchy is deleted when a business rule references parents within the hierarchy.
• A version flag that is assigned to a version is deleted.

Applies to