IsValidStateTransitionRequest Class


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

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

For the Web API use the IsValidStateTransition Function.

Namespace:   Microsoft.Crm.Sdk.Messages
Assembly:  Microsoft.Crm.Sdk.Proxy (in Microsoft.Crm.Sdk.Proxy.dll)

Inheritance Hierarchy



[DataContractAttribute(Namespace = "")]
public sealed class IsValidStateTransitionRequest : OrganizationRequest
<DataContractAttribute(Namespace := "")>
Public NotInheritable Class IsValidStateTransitionRequest
    Inherits OrganizationRequest


Name Description
System_CAPS_pubmethod IsValidStateTransitionRequest()

Initializes a new instance of the IsValidStateTransitionRequest class.


Name Description
System_CAPS_pubproperty Entity

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

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 NewState

Gets or sets the proposed new state for the record.

System_CAPS_pubproperty NewStatus

Gets or sets the proposed new status for the record.

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


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


Message Availability

This message works regardless whether the caller is connected to the server or offline.


Pass an instance of this class to the Execute 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. For a complete list of the required privileges, see IsValidStateTransition message privileges.

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 Entities

The following table shows the default entities that support this message. For the listed entities of this message, the Availability column shows Server if the caller must be connected to the server and shows Both if the caller can be either connected to, or disconnected from, the server.




2 (Both)


2 (Both)


2 (Both)


2 (Both)


2 (Both)


2 (Both)


2 (Both)


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.

// Create an EntityReference to represent an open case
EntityReference caseReference = new EntityReference()
    LogicalName = Incident.EntityLogicalName,
    Id = _caseIncidentId

IsValidStateTransitionRequest checkState = 
    new IsValidStateTransitionRequest();

// Set the transition request to an open case
checkState.Entity = caseReference;

// Check to see if a new state of "resolved" and 
// a new status of "problem solved" are valid
checkState.NewState = IncidentState.Resolved.ToString();
checkState.NewStatus = (int)incident_statuscode.ProblemSolved;

// Execute the request
IsValidStateTransitionResponse checkStateResponse = 

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

Microsoft.Crm.Sdk.Messages Namespace
Opportunity entities
Incident (case) entities
IsValidStateTransition message privileges
Sample: Validate record state and set the state of the record
How role-based security can be used to control access to entities in Microsoft Dynamics 365
How record-based security can be used to control access to records in Microsoft Dynamics 365

Return to top

Microsoft Dynamics 365

© 2016 Microsoft. All rights reserved. Copyright