UpdateStateValueRequest Class

 

Updated: November 29, 2016

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)

SystemObject
  Microsoft.Xrm.SdkOrganizationRequest
    Microsoft.Xrm.Sdk.MessagesUpdateStateValueRequest

No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_pubmethodUpdateStateValueRequest

Initializes a new instance of the UpdateStateValueRequest class.

NameDescription
System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

For internal use only.

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

System_CAPS_pubproperty

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

NameDescription
System_CAPS_pubmethodEquals

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode

(Inherited from Object.)

System_CAPS_pubmethodGetType

(Inherited from Object.)

System_CAPS_pubmethodToString

(Inherited from Object.)

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.

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.

No code example is currently available or this language may not be supported.

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

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright

Community Additions

ADD
Show: