UpdateEntityRequest UpdateEntityRequest UpdateEntityRequest UpdateEntityRequest Class

Definition

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

public ref class UpdateEntityRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class UpdateEntityRequest : Microsoft.Xrm.Sdk.OrganizationRequest
type UpdateEntityRequest = class
    inherit OrganizationRequest
Public NotInheritable Class UpdateEntityRequest
Inherits OrganizationRequest
Inheritance
UpdateEntityRequestUpdateEntityRequestUpdateEntityRequestUpdateEntityRequest
Attributes

Examples

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.

// Update Entity 
        EntityMetadata BankAccountEntity = retrieveBankAccountEntityResponse.EntityMetadata;

// Disable Mail merge BankAccountEntity.IsMailMergeEnabled = new BooleanManagedProperty(false);

// Enable Notes UpdateEntityRequest updateBankAccountRequest = new UpdateEntityRequest { Entity = BankAccountEntity, HasNotes = true }; svc.Execute(updateBankAccountRequest);

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.

entities#CreateUpdateEntityMetadata8 entitiesVB#CreateUpdateEntityMetadata8

Remarks

Message Availability

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

Usage

Pass an instance of this class to the Execute(OrganizationRequest) 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

Constructors

UpdateEntityRequest() UpdateEntityRequest() UpdateEntityRequest() UpdateEntityRequest()

Initializes a new instance of the UpdateEntityRequest class

Properties

Entity Entity Entity Entity

Gets or sets the metadata for the entity. Required.

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
HasActivities HasActivities HasActivities 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.

HasFeedback HasFeedback HasFeedback HasFeedback

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

HasNotes HasNotes HasNotes HasNotes

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

Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
MergeLabels MergeLabels MergeLabels MergeLabels

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

Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
SolutionUniqueName SolutionUniqueName SolutionUniqueName SolutionUniqueName

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

Applies to