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

System.Object
  Microsoft.Xrm.Sdk.OrganizationRequest
    Microsoft.Crm.Sdk.Messages.IsValidStateTransitionRequest

[DataContractAttribute(Namespace = "http://schemas.microsoft.com/crm/2011/Contracts")]
public sealed class IsValidStateTransitionRequest : OrganizationRequest

NameDescription
System_CAPS_pubmethodIsValidStateTransitionRequest()

Initializes a new instance of the IsValidStateTransitionRequest class.

NameDescription
System_CAPS_pubpropertyEntity

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

System_CAPS_pubpropertyExtensionData

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

System_CAPS_pubpropertyItem[String]

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

System_CAPS_pubpropertyNewState

Gets or sets the proposed new state for the record.

System_CAPS_pubpropertyNewStatus

Gets or sets the proposed new status for the record.

System_CAPS_pubpropertyParameters

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

System_CAPS_pubpropertyRequestId

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

System_CAPS_pubpropertyRequestName

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

NameDescription
System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodToString()

(Inherited from Object.)

Message Availability

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

Usage

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.

Entity

Availability

Incident

2 (Both)

msdyn_PostAlbum

2 (Both)

msdyn_PostConfig

2 (Both)

msdyn_PostRuleConfig

2 (Both)

msdyn_wallsavedquery

2 (Both)

msdyn_wallsavedqueryusersettings

2 (Both)

Opportunity

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 = 
    (IsValidStateTransitionResponse)_serviceProxy.Execute(checkState);

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: