This documentation is archived and is not being maintained.

RemoveRelated Message (CrmService)

Dynamics
banner art

[Applies to: Microsoft Dynamics CRM 4.0]

Find the latest SDK documentation: CRM 2015 SDK

Works for all deployment typesWorks online and offline

Removes the relationship between two entity instances as defined by the target classes listed below. For example, remove the relationship between an invoice and a contact.

The relevant classes are specified in the following table.

TypeClass
RequestRemoveRelatedRequest
ResponseRemoveRelatedResponse
TargetTargetRelated
EntitySee the following table.

The following table shows the entities and target classes for this message.

EntityTarget Class
invoiceTargetRelatedInvoiceToContact
leadTargetRelatedLeadToAccount

TargetRelatedLeadToContact

opportunityTargetRelatedOpportunityToAccount

TargetRelatedOpportunityToCompetitor

TargetRelatedOpportunityToContact

productTargetRelatedProductToCompetitor

TargetRelatedProductToLead

quoteTargetRelatedQuoteToContact
salesliteratureTargetRelatedSalesLiteratureToCompetitor

TargetRelatedSalesLiteratureToProduct

salesorderTargetRelatedSalesOrderToContact

Remarks

To use this message, pass an instance of the RemoveRelatedRequest class as the request parameter in the Execute method.

To perform this action, the caller must have access rights on the entity instance specified in the request class. For a list of required privileges, see RemoveRelated Privileges.

The RemoveRelated and SetRelated messages support all types of relationships, including one-to-many and many-to-many. RemoveRelated and SetRelated can also be used with custom entities.

Example

The following code example shows how to use the RemoveRelated message.

[C#]
// Set up the CRM service.
CrmAuthenticationToken token = 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";
 
CrmService service = new CrmService();
service.Url = "http://<servername>:<port>/mscrmservices/2007/crmservice.asmx";
service.CrmAuthenticationTokenValue = token;
service.Credentials = System.Net.CredentialCache.DefaultCredentials;

// Create the target object for the request.
TargetRelatedLeadToAccount target = new TargetRelatedLeadToAccount();

// AccountId is the GUID of the account to be related to the lead.
target.AccountId = new Guid("D3652E9C-D328-4CA1-B284-1215C441AD94");

// LeadId is the GUID of the lead to be related to the account.
target.LeadId = new Guid("9DAEE309-A3D6-470C-80E2-DDC657BAFC16");

// Create the request object.
RemoveRelatedRequest remove = new RemoveRelatedRequest();

// Set the properties of the request object.
remove.Target = target;

// Execute the request.
RemoveRelatedResponse related = (RemoveRelatedResponse)service.Execute(remove);
[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"
 
Dim service As New CrmService()
service.Url = "http://<servername>:<port>/mscrmservices/2007/crmservice.asmx"
service.CrmAuthenticationTokenValue = token
service.Credentials = System.Net.CredentialCache.DefaultCredentials

' Create the target object for the request.
Dim target As New TargetRelatedLeadToAccount()

' AccountId is the GUID of the account to be related to the lead.
target.AccountId = New Guid("D3652E9C-D328-4CA1-B284-1215C441AD94")

' LeadId is the GUID of the lead to be related to the account.
target.LeadId = New Guid("9DAEE309-A3D6-470C-80E2-DDC657BAFC16")

' Create the request object.
Dim remove As New RemoveRelatedRequest()

' Set the properties of the request object.
remove.Target = target

' Execute the request.
Dim related As RemoveRelatedResponse = CType(service.Execute(remove), RemoveRelatedResponse)

See Also

Reference


© 2010 Microsoft Corporation. All rights reserved.


Show: