UpdateStateValueRequest Class

Definition

Namespace:

Microsoft.Xrm.Sdk.Messages

Assembly:

Microsoft.Xrm.Sdk.dll

Package:

Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Contains the data that is needed to update an option set value in for a StateAttributeMetadata column.

public ref class UpdateStateValueRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest

[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class UpdateStateValueRequest : Microsoft.Xrm.Sdk.OrganizationRequest

[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/xrm/2011/Contracts")>]
type UpdateStateValueRequest = class
    inherit OrganizationRequest

Public NotInheritable Class UpdateStateValueRequest
Inherits OrganizationRequest

Inheritance

Object

OrganizationRequest

UpdateStateValueRequest

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 a state value option
/// </summary>
/// <param name="service">The authenticated IOrganizationService instance</param>
static void UpdateStateValueExample(IOrganizationService service)
{
      string tableLogicalName = "account";
      string stateColumnLogicalName = "statecode";
      int optionValue = 1; //Inactive
      string newLabel = "Dormant";
      string newDescription = "A dormant account is not active";
      int languageCode = 1033; // English

      UpdateStateValueRequest request = new()
      {
         EntityLogicalName = tableLogicalName,
         AttributeLogicalName = stateColumnLogicalName,
         Value = optionValue,
         Label = new Label(newLabel, languageCode),
         Description = new Label(newDescription, languageCode),            
         MergeLabels = true,
         // DefaultStatusCode could be used when when there
         // are customized statuscode options

      };

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

Sample code on GitHub

Work with attribute metadata

Remarks

For the Web API use the UpdateStateValue action.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have the System administrator or System customizer security roles.

Supported Columns

You can use this method to update any unmanaged State column.

Constructors

UpdateStateValueRequest()

Initializes a new instance of the UpdateStateValueRequest class.

Properties

AttributeLogicalName	Gets or sets the logical name of the column. Optional.
DefaultStatusCode	Gets or sets the default value for the statuscode (status reason) column when this statecode value is set. Optional.
Description	Gets or sets the description label for the statecode option that is specified in the Value property. Optional.
EntityLogicalName	Gets or sets the name of the table that has this statecode attribute. 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 display label for this statecode option that is specified by the Value property. Optional.
MergeLabels	Gets or sets whether to merge the current label with any existing labels that are already specified for this attribute. Required.
OptionSetName	For internal use only.
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 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)
Value	Gets or sets the statecode attribute options to update. Required.

See also

• UpdateStateValueResponse
• StateAttributeMetadata