UpdateStateValueRequest UpdateStateValueRequest UpdateStateValueRequest UpdateStateValueRequest Class

Definition

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

For the Web API use the UpdateStateValue Action.

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
type UpdateStateValueRequest = class
    inherit OrganizationRequest
Public NotInheritable Class UpdateStateValueRequest
Inherits OrganizationRequest
Inheritance
UpdateStateValueRequestUpdateStateValueRequestUpdateStateValueRequestUpdateStateValueRequest
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 state value label from Active to Open.
// Create the request.
UpdateStateValueRequest updateStateValue = new UpdateStateValueRequest
{
    AttributeLogicalName = "statecode",
    EntityLogicalName = Contact.EntityLogicalName,
    Value = 1,
    Label = new Label("Open", _languageCode)
};
    // Execute the request.
svc.Execute(updateStateValue);
Console.WriteLine(
    "Updated {0} state attribute of {1} entity from 'Active' to '{2}'.",
    updateStateValue.AttributeLogicalName,
    updateStateValue.EntityLogicalName,
    updateStateValue.Label.LocalizedLabels[0].Label
    );

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 the UpdateStateValueResponse class.

Privileges and Access Rights

To perform this action, the caller must have the required privileges, as listed in UpdateAttribute message privileges.

Supported Attributes

You can use this method to update any unmanaged attribute of type State.

Constructors

UpdateStateValueRequest() UpdateStateValueRequest() UpdateStateValueRequest() UpdateStateValueRequest()

Initializes a new instance of the UpdateStateValueRequest class.

Properties

AttributeLogicalName AttributeLogicalName AttributeLogicalName AttributeLogicalName

Gets or sets the logical name of the attribute. Optional.

DefaultStatusCode DefaultStatusCode DefaultStatusCode DefaultStatusCode

Gets or sets the default value for the statuscode (status reason) attribute when this statecode value is set. Optional.

Description Description Description Description

Gets or sets the description label for the statecode option that is specified in the Value property. Optional.

EntityLogicalName EntityLogicalName EntityLogicalName EntityLogicalName

Gets or sets the name of the entity that has this statecode attribute. Optional.

ExtensionData ExtensionData ExtensionData ExtensionData

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

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
Label Label Label Label

Gets or sets the display label for this statecode option that is specified by the Value property. Optional.

MergeLabels MergeLabels MergeLabels MergeLabels

Gets or sets whether to merge the current label with any existing labels that are already specified for this attribute. Required.

OptionSetName OptionSetName OptionSetName OptionSetName

For internal use only.

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

Gets or sets the statecode attribute options to update. Required.

Applies to

See also