DeleteEntity Message (MetadataService)
.gif "banner art") |
[Applies to: Microsoft Dynamics CRM 4.0]
Find the latest SDK documentation: CRM 2015 SDK
| Works for all deployment types | Works online only |
Deletes an entity.
The relevant classes are specified in the following table.
| Type | Class |
| Request | DeleteEntityRequest |
| Response | DeleteEntityResponse |
Remarks
The delete operation will fail if there are any workflows that refer to the entity, regardless of whether they are published or unpublished.
To perform this action, the caller must be a user in the organization for which metadata is requested and must have Delete Entity and Delete Attributes privileges.
Example
The following example shows how to use the DeleteEntity message.
[C#]
// Create an authentication token.
CrmAuthenticationToken token = new CrmAuthenticationToken();
token.OrganizationName = "AdventureWorksCycle";
// You can use enums.cs from the SDK\Helpers folder to get the enumeration for Active Directory authentication.
token.AuthenticationType = 0;
// Create the metadata Web service.
MetadataService metadataService = new MetadataService();
metadataService.Url = "http://<servername>:<port>/MSCRMServices/2007/MetadataService.asmx";
metadataService.CrmAuthenticationTokenValue = token;
metadataService.Credentials = System.Net.CredentialCache.DefaultCredentials;
metadataService.PreAuthenticate = true;
// Create the request.
DeleteEntityRequest deleteRequest = new DeleteEntityRequest();
deleteRequest.LogicalName = "new_mycustomentity";
// Execute the request.
DeleteEntityResponse deleteResponse = (DeleteEntityResponse)metadataService.Execute(deleteRequest);
[Visual Basic .NET]
' Set up the CRM service.
Dim token As New CrmAuthenticationToken()
' You can use enums.cs from the SDK\Helpers folder to get the enumeration for Active Directory authentication.
token.AuthenticationType = 0
token.OrganizationName = "AdventureWorksCycle";
// Create the metadata Web service.
Dim metadataService As New MetadataService ()
metadataService.Url = "http://<servername>:<port>/mscrmservices/2007/MetadataService.asmx";
metadataService.CrmAuthenticationTokenValue = token;
metadataService.Credentials = System.Net.CredentialCache.DefaultCredentials
metadataService.PreAuthenticate = true;
' Create the request.
Dim deleteRequest As New DeleteEntityRequest()
deleteRequest.LogicalName = "new_mycustomentity"
' Execute the request.
Dim deleteResponse As DeleteEntityResponse = CType(metadataService.Execute(deleteRequest), DeleteEntityResponse)
See Also
Concepts
Reference