Share via


UpdateOptionValueRequest Class

Definition

Contains the data that is needed to update an option value in a global or local choice.

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

/// <summary>
/// Demonstrates updating an option in a global choice
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
static void UpdateGlobalOption(IOrganizationService service) {

      string solutionUniqueName = "SolutionName";
      string prefix = "sample";
      string choiceName = $"{prefix}_status";
      int optionValue = 152960003;
      string newLabel = "Completed";
      int languageCode = 1033; // English

      UpdateOptionValueRequest request = new() {
         OptionSetName = choiceName, // For global choice column
         Value = optionValue,
         Label = new Label(newLabel, languageCode),
         SolutionUniqueName = solutionUniqueName,
         // Use these properties for local choice columns
         //EntityLogicalName = "account",
         //AttributeLogicalName = "accountcategorycode"
      };

      //Send the request
      service.Execute(request);

      //Publish the OptionSet
      PublishXmlRequest publishRequest = new()
      {
          ParameterXml = $@"<importexportxml><optionsets><optionset>{{choiceName}}</optionset></optionsets></importexportxml>"
      };
      service.Execute(publishRequest);
}

Sample code on GitHub

Work with choice columns

Remarks

Usage

Pass an instance of this class to the Execute(OrganizationRequest) method, which returns an instance of UpdateOptionValueResponse.

Privileges and Access Rights

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

Notes for Callers

Constructors

UpdateOptionValueRequest()

Initializes a new instance of the UpdateOptionValueRequest class.

Properties

AttributeLogicalName

Gets or sets the name of the column when updating a local choice in a picklist column. Optional.

Description

Gets or sets a description for the option. Optional.

EntityLogicalName

Gets or sets the logical name of the table when updating the local choice in a picklist column. Optional.

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)
Label

Gets or sets the label for the option. Optional.

MergeLabels

Gets or sets whether to keep text defined for languages not included in the Label. Required.

OptionSetName

Gets or sets the name of the global choice. Optional.

Parameters

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

(Inherited from OrganizationRequest)
ParentValues
RequestId

Gets or sets the ID of the request. 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 unmanaged solution that this global choice should be associated with. Optional.

Value

Gets or sets the value for the option. Required.

Applies to