UpdateOptionValueRequest Class

Definition

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

Object

OrganizationRequest

UpdateOptionValueRequest

Attributes

DataContractAttribute

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

Properties

Applies to