Share via


IsValidStateTransitionRequest Class

Definition

Contains the data that is needed to validate the state transition.

public ref class IsValidStateTransitionRequest sealed : Microsoft::Xrm::Sdk::OrganizationRequest
[System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class IsValidStateTransitionRequest : Microsoft.Xrm.Sdk.OrganizationRequest
[<System.Runtime.Serialization.DataContract(Namespace="http://schemas.microsoft.com/crm/2011/Contracts")>]
type IsValidStateTransitionRequest = class
    inherit OrganizationRequest
Public NotInheritable Class IsValidStateTransitionRequest
Inherits OrganizationRequest
Inheritance
IsValidStateTransitionRequest
Attributes

Examples

Example code that demonstrates this message request can be found here: ValidateAndSetRecordState.

Remarks

For the Web API use the IsValidStateTransition function.

Usage

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

Privileges and Access Rights

To perform this action, the caller must have privileges on the specified entity in the Entity property and access rights on the specified record in the Entity property.

Notes for Callers

If an incident (case) or opportunity is already closed or canceled, or if an incident (case) has open activities, an exception is thrown.

Supported Tables

To obtain a list of default entities that support this message see Table support for messages.

Constructors

IsValidStateTransitionRequest()

Initializes a new instance of the IsValidStateTransitionRequest class.

Properties

Entity

Gets or sets the entity reference for the record whose transition state is validated.

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

Gets or sets the proposed new state for the record.

NewStatus

Gets or sets the proposed new status for the record.

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)

Applies to

See also