UpdateAttributeRequest Class

Definition

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

public ref class UpdateAttributeRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class UpdateAttributeRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type UpdateAttributeRequest = class
    inherit OrganizationRequest
Public NotInheritable Class UpdateAttributeRequest
Inherits OrganizationRequest
Inheritance
UpdateAttributeRequest
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.

// Modify the retrieved attribute
AttributeMetadata retrievedAttributeMetadata =
    attributeResponse.AttributeMetadata;
retrievedAttributeMetadata.DisplayName =
    new Label("Update String Attribute", _languageCode);

// Update an attribute retrieved via RetrieveAttributeRequest
UpdateAttributeRequest updateRequest = new UpdateAttributeRequest
{
    Attribute = retrievedAttributeMetadata,
    EntityName = Contact.EntityLogicalName,
    MergeLabels = false
};

// Execute the request
svc.Execute(updateRequest);
Console.WriteLine("Updated the attribute {0}.",
    retrievedAttributeMetadata.SchemaName);

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.

attributes#WorkWithAttributes5 attributesVB#WorkWithAttributes5

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 UpdateAttributeResponse.

Privileges and Access Rights

To perform this action, the caller must have privileges listed in UpdateAttribute 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

UpdateAttributeRequest()

Initializes a new instance of the UpdateAttributeRequest class

Properties

Attribute

Gets or sets the attribute metadata to be updated. Required.

EntityName

Gets or sets the logical name of the entity to which the attribute belongs. Required.

ExtensionData

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

(Inherited from OrganizationRequest)
Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
MergeLabels

Gets or sets whether the label metadata will be merged or overwritten. Required.

Parameters

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

(Inherited from OrganizationRequest)
RequestId

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

(Inherited from OrganizationRequest)
RequestName

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

(Inherited from OrganizationRequest)
SolutionUniqueName

Gets or sets the name of the solution to associate the entity with. Optional.

Applies to