UpdateStateValueRequest Class

 

Applies To: Dynamics 365 (online), Dynamics 365 (on-premises), Dynamics CRM 2016, Dynamics CRM Online

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.

Namespace:   Microsoft.Xrm.Sdk.Messages
Assembly:  Microsoft.Xrm.Sdk (in Microsoft.Xrm.Sdk.dll)

Inheritance Hierarchy

System.Object
  Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Xrm.Sdk.Messages.UpdateStateValueRequest

Syntax

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/xrm/2011/Contracts")]
public sealed class UpdateStateValueRequest : OrganizationRequest
<DataContractAttribute(Namespace := "http://schemas.microsoft.com/xrm/2011/Contracts")>
Public NotInheritable Class UpdateStateValueRequest
    Inherits OrganizationRequest

Constructors

Name Description
System_CAPS_pubmethod UpdateStateValueRequest()

Initializes a new instance of the UpdateStateValueRequest class.

Properties

Name Description
System_CAPS_pubproperty AttributeLogicalName

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

System_CAPS_pubproperty DefaultStatusCode

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

System_CAPS_pubproperty Description

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

System_CAPS_pubproperty EntityLogicalName

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

System_CAPS_pubproperty ExtensionData

Gets or sets the structure that contains extra data. Optional.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Item[String]

Gets or sets the indexer for the Parameters collection.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Label

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

System_CAPS_pubproperty MergeLabels

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

System_CAPS_pubproperty OptionSetName

For internal use only.

System_CAPS_pubproperty Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty RequestId

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

System_CAPS_pubproperty RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.(Inherited from OrganizationRequest.)

System_CAPS_pubproperty Value

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

Methods

Name Description
System_CAPS_pubmethod Equals(Object)

(Inherited from Object.)

System_CAPS_pubmethod GetHashCode()

(Inherited from Object.)

System_CAPS_pubmethod GetType()

(Inherited from Object.)

System_CAPS_pubmethod ToString()

(Inherited from Object.)

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

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. For the complete sample, see the link later in this topic.


// 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.
_serviceProxy.Execute(updateStateValue);

Console.WriteLine(
    "Updated {0} state attribute of {1} entity from 'Active' to '{2}'.",
    updateStateValue.AttributeLogicalName,
    updateStateValue.EntityLogicalName,
    updateStateValue.Label.LocalizedLabels[0].Label
    );

' Modify the state value label from Active to Open.
' Create the request.
Dim updateStateValue As UpdateStateValueRequest = New UpdateStateValueRequest With {
 .AttributeLogicalName = "statecode",
 .EntityLogicalName = Contact.EntityLogicalName,
 .Value = 1,
 .Label = New Label("Open", _languageCode)}

' Execute the request.
_serviceProxy.Execute(updateStateValue)

Console.WriteLine("Updated {0} state attribute of {1} entity from 'Active' to '{2}'.",
                  updateStateValue.AttributeLogicalName,
                  updateStateValue.EntityLogicalName,
                  updateStateValue.Label.LocalizedLabels(0).Label)

Thread Safety

Any public static ( Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

UpdateStateValueResponse
StateAttributeMetadata
Microsoft.Xrm.Sdk.Messages Namespace
Update a state value
Sample: Work with attribute metadata
UpdateAttribute message privileges

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright