SetStateRequest Class

Reference

Definition

Namespace:: Microsoft.Crm.Sdk.Messages

Assembly:: Microsoft.Crm.Sdk.Proxy.dll

Package:: Microsoft.PowerPlatform.Dataverse.Client v1.1.32

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Deprecated. Contains the data that's needed to set the state of an entity record.

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

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

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

Public NotInheritable Class SetStateRequest
Inherits OrganizationRequest

Inheritance: Object

OrganizationRequest
SetStateRequest

Attributes: DataContractAttribute

Remarks

This message request is deprecated. Use the UpdateRequest instead. For more information see Legacy update messages.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the specified entity in the EntityMoniker property.

Valid State and Status value combinations

The valid combinations of state and status code values varies for many entities. For a list of default values for specific system entities, see Dataverse table/entity reference.

For a list of the state and status values valid for custom tables in your organization, refer to the table definition. You can use a table definition browser like the one described in Browse table definitions in your environment.

Supported Tables

See Message support for tables for an example query you can use to get the list of tables you can use with the SetState message.

Constructors

SetStateRequest()

Initializes a new instance of the SetStateRequest class.

Properties

EntityMoniker	Gets or sets a reference to the entity. Required.
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)
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)
State	Gets or sets the state of the entity record. Required.
Status	Gets or sets the status that corresponds to the `State` property. Required.

Applies to

Partilhar via