UpdateEntityRequest Class


Applies To: Dynamics CRM 2015

Contains the data that is needed to update the definition of an entity.

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

Inheritance Hierarchy



[DataContractAttribute(Namespace = "http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class UpdateEntityRequest : OrganizationRequest
[DataContractAttribute(Namespace = "http://schemas.microsoft.com/xrm/2011/Contracts")]
public ref class UpdateEntityRequest sealed : OrganizationRequest
[<DataContractAttribute(Namespace = "http://schemas.microsoft.com/xrm/2011/Contracts")>]
type UpdateEntityRequest = 
        inherit OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/xrm/2011/Contracts")>
Public NotInheritable Class UpdateEntityRequest
    Inherits OrganizationRequest


Name Description
System_CAPS_pubmethod UpdateEntityRequest()

Initializes a new instance of the UpdateEntityRequest class


Name Description
System_CAPS_pubproperty Entity

Gets or sets the metadata for the entity. Required.

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty HasActivities

Gets or sets whether the entity will have a special relationship to activity entities and is a valid regarding object for the activity. Optional.

System_CAPS_pubproperty HasNotes

Gets or sets whether the entity will have a special relationship to the annotation entity. Optional.

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty MergeLabels

Gets or sets whether to merge the new labels with any existing labels. Required.

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

Gets or sets the ID of an asynchronous operation (system job). Optional. (Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty SolutionUniqueName

Gets or sets the unique name of the unmanaged solution that this entity should be associated with. Optional.


Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)


Message Availability

For this message to work, the caller must be connected to the server.


Pass an instance of this class to the Execute method, which returns an instance of UpdateEntityResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges listed in UpdateEntity message privileges.

Notes for Callers

You must publish the changes to the metadata before this change will be visible in the application. For more information, see Publish customizations


The following example shows how to use this message. For this sample to work correctly, you must be connected to the server to get an IOrganizationService interface. For the complete sample, see the link later in this topic.

EntityMetadata BankAccountEntity = retrieveBankAccountEntityResponse.EntityMetadata;

// Disable Mail merge
BankAccountEntity.IsMailMergeEnabled = new BooleanManagedProperty(false);
// Enable Notes
UpdateEntityRequest updateBankAccountRequest = new UpdateEntityRequest
 Entity = BankAccountEntity,
 HasNotes = true


Dim BankAccountEntity As EntityMetadata = retrieveBankAccountEntityResponse.EntityMetadata

' Disable Mail merge
BankAccountEntity.IsMailMergeEnabled = New BooleanManagedProperty(False)
' Enable Notes
Dim updateBankAccountRequest As UpdateEntityRequest = New UpdateEntityRequest With {
 .Entity = BankAccountEntity,
 .HasNotes = True

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Microsoft.Xrm.Sdk.Messages Namespace
Sample: Create and update entity metadata
Retrieve, update, and delete entities
Customize entity metadata

Return to top

© 2016 Microsoft. All rights reserved. Copyright