IsValidStateTransitionRequest IsValidStateTransitionRequest IsValidStateTransitionRequest IsValidStateTransitionRequest Class

Definition

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

For the Web API use the IsValidStateTransition Function.

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
type IsValidStateTransitionRequest = class
    inherit OrganizationRequest
Public NotInheritable Class IsValidStateTransitionRequest
Inherits OrganizationRequest
Inheritance
IsValidStateTransitionRequestIsValidStateTransitionRequestIsValidStateTransitionRequestIsValidStateTransitionRequest
Attributes

Examples


      // Create an EntityReference to represent an open case
var caseReference = new EntityReference()
{
    LogicalName = Incident.EntityLogicalName,
    Id = _caseIncidentId
};
    var 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
var checkStateResponse = (IsValidStateTransitionResponse)svc.Execute(checkState);

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.

BusinessManagement#IsValidStateTransition

Remarks

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

Constructors

IsValidStateTransitionRequest() IsValidStateTransitionRequest() IsValidStateTransitionRequest() IsValidStateTransitionRequest()

Initializes a new instance of the IsValidStateTransitionRequest class.

Properties

Entity Entity Entity Entity

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

ExtensionData ExtensionData ExtensionData ExtensionData

Gets or sets the structure that contains extra data. Optional.

(Inherited from OrganizationRequest)
Item[String] Item[String] Item[String] Item[String]

Gets or sets the indexer for the Parameters collection.

(Inherited from OrganizationRequest)
NewState NewState NewState NewState

Gets or sets the proposed new state for the record.

NewStatus NewStatus NewStatus NewStatus

Gets or sets the proposed new status for the record.

Parameters Parameters Parameters Parameters

Gets or sets the collection of parameters for the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)
RequestId RequestId RequestId RequestId

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

(Inherited from OrganizationRequest)
RequestName RequestName RequestName RequestName

Gets or sets the name of the request. Required, but is supplied by derived classes.

(Inherited from OrganizationRequest)

Applies to

See also