IOrganizationService.Disassociate Method (String, Guid, Relationship, EntityReferenceCollection)

 

Applies To: Dynamics CRM 2015

Deletes a link between records.

Namespace:   Microsoft.Xrm.Sdk
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Syntax

[FaultContractAttribute(typeof(OrganizationServiceFault))]
[OperationContractAttribute]
void Disassociate(
    string entityName,
    Guid entityId,
    Relationship relationship,
    EntityReferenceCollection relatedEntities
)

[FaultContractAttribute((OrganizationServiceFault^::typeid))]
[OperationContractAttribute]
void Disassociate(
    String^ entityName,
    Guid entityId,
    Relationship^ relationship,
    EntityReferenceCollection^ relatedEntities
)

[<FaultContractAttribute(typeof(OrganizationServiceFault))>]
[<OperationContractAttribute>]
abstract Disassociate : 
        entityName:string *
        entityId:Guid *
        relationship:Relationship *
        relatedEntities:EntityReferenceCollection -> unit

<FaultContractAttribute(GetType(OrganizationServiceFault))>
<OperationContractAttribute>
Sub Disassociate (
    entityName As String,
    entityId As Guid,
    relationship As Relationship,
    relatedEntities As EntityReferenceCollection
)

Parameters

• entityName
  Type: System.String

  Type: String. The logical name of the entity that is specified in the entityId parameter.

• entityId
  Type: System.Guid

  Type: Guid. The ID of the record from which the related records are disassociated.

• relationship
  Type: Microsoft.Xrm.Sdk.Relationship

  Type: Relationship. The name of the relationship to be used to remove the link.

• relatedEntities
  Type: Microsoft.Xrm.Sdk.EntityReferenceCollection

  Type: EntityReferenceCollection. A collection of entity references (references to records) to be disassociated.

Remarks

Message Availability

 This message works regardless whether the caller is connected to the server or offline.

Privileges and Access Rights

To perform this action, the caller must have privileges on the entity that is specified in the entityName parameter and access rights on the records that are specified in the entityId and relatedEntities parameters. For a list of the required privileges, see Delete message privileges.

Notes for Callers

This method removes multiple associations in one transaction between the record that is specified by the entityId parameter and each record in the relatedEntities parameter for the relationship that is specified in the relationship parameter.

For a one-to-many relationship, this method clears the ReferencingAttribute in the related record to the value of entityId.

For a many-to-many relationship, this method deletes a record in the intersect table for the relationship. The intersect table name is defined in the IntersectEntityName property for the relationship. You need this when you query for the records. However, you need the relationship name to set the Relationship property. This name is defined in the SchemaName property for the relationship.

For more information about the exceptions that can be thrown when this method is called, see Handle exceptions in your code.

Supported Entities

You can use this method to disassociate any records that participate in a relationship, including records for custom entities.

Examples

The following example demonstrates how to use the Disassociate method to remove an association or link between records (early bound).

// Associate the accounts to the contact record.

// Create a collection of the entities that will be 
// associated to the contact.
EntityReferenceCollection relatedEntities = new EntityReferenceCollection();
relatedEntities.Add(new EntityReference(Account.EntityLogicalName, _account1Id));
relatedEntities.Add(new EntityReference(Account.EntityLogicalName, _account2Id));
relatedEntities.Add(new EntityReference(Account.EntityLogicalName, _account3Id));

// Create an object that defines the relationship between the contact and account.
Relationship relationship = new Relationship("account_primary_contact");


//Associate the contact with the 3 accounts.
_service.Associate(Contact.EntityLogicalName, _contactId, relationship,
    relatedEntities);

Console.WriteLine("The entities have been associated.");

//Disassociate the records.
_service.Disassociate(Contact.EntityLogicalName, _contactId, relationship,
    relatedEntities);

' Associate the accounts to the contact record.

' Create a collection of the entities that will be 
' associated to the contact.
Dim relatedEntities As New EntityReferenceCollection()
relatedEntities.Add(New EntityReference(Account.EntityLogicalName, _account1Id))
relatedEntities.Add(New EntityReference(Account.EntityLogicalName, _account2Id))
relatedEntities.Add(New EntityReference(Account.EntityLogicalName, _account3Id))

' Create an object that defines the relationship between the contact and account.
Dim relationship As New Relationship("account_primary_contact")


'Associate the contact with the 3 accounts.
_service.Associate(Contact.EntityLogicalName, _contactId, relationship, relatedEntities)

Console.WriteLine("The entities have been associated.")

'Disassociate the records.
_service.Disassociate(Contact.EntityLogicalName, _contactId, relationship, relatedEntities)

The following example demonstrates how to use the Disassociate method to remove an association or link between records (late bound).

// The account ID would typically be passed in as an argument or determined by a query.
// The contact ID would typically be passed in as an argument or determined by a query.
// Associate the accounts to the contact record.

//Create a collection of the entity ids that will be associated to the contact.
EntityReferenceCollection relatedEntities = new EntityReferenceCollection();
relatedEntities.Add(new EntityReference("account", _account1Id));
relatedEntities.Add(new EntityReference("account", _account2Id));
relatedEntities.Add(new EntityReference("account", _account3Id));

// Create an object that defines the relationship between the contact and account.
Relationship relationship = new Relationship("account_primary_contact");

//Associate the contact with the 3 accounts.
_service.Associate("contact", _contactId, relationship, relatedEntities);

Console.WriteLine("The entities have been associated.");

//Disassociate the records.
_service.Disassociate("contact", _contactId, relationship, relatedEntities);

' The account ID would typically be passed in as an argument or determined by a query.
' The contact ID would typically be passed in as an argument or determined by a query.
' Associate the accounts to the contact record.

'Create a collection of the entity ids that will be associated to the contact.
Dim relatedEntities As New EntityReferenceCollection()
relatedEntities.Add(New EntityReference("account", _account1Id))
relatedEntities.Add(New EntityReference("account", _account2Id))
relatedEntities.Add(New EntityReference("account", _account3Id))

' Create an object that defines the relationship between the contact and account.
Dim relationship As New Relationship("account_primary_contact")

'Associate the contact with the 3 accounts.
_service.Associate("contact", _contactId, relationship, relatedEntities)

Console.WriteLine("The entities have been associated.")

'Disassociate the records.
_service.Disassociate("contact", _contactId, relationship, relatedEntities)

See Also

DisassociateRequest
DisassociateResponse
IOrganizationService Interface
Microsoft.Xrm.Sdk Namespace
Sample: Associate records (early bound)
Entity metadata
Customize entity relationship metadata
Handle exceptions in your code
Troubleshooting and error handling
Disassociate

Return to top

© 2016 Microsoft. All rights reserved. Copyright