GetWorkflowStateTransitionsAsJSON Method

If the pointer is not NULL, it points to a struct that specifies the object version for which the state transitions are inquired. If the pointer is NULL, the "bSelectable" flags of all state transitions that involve pseudo-users will be true because transition rights cannot be checked in that case.

Description

Receives the state transitions as a JSON string. The 'Selectable' flag of each transition is determined based on the specified current state and object version.

Syntax

Visual Basic
Public Function GetWorkflowStateTransitionsAsJSON( _ ByVal Workflow As Long, _ Optional ByVal CurrentState As TypedValue = 0, _ Optional ByVal ObjVer As ObjVer = 0 _ ) As String

Visual Basic

Public Function GetWorkflowStateTransitionsAsJSON( _
   ByVal Workflow As Long, _
   Optional ByVal CurrentState As TypedValue = 0, _
   Optional ByVal ObjVer As ObjVer = 0 _
) As String

Parameters

Workflow: The ID that identifies the workflow.
CurrentState: The specified current state affects to the returned transitions so that their "Selectable" properties are set according to the rules defined in the workflows and state definitions.
ObjVer: If the pointer is not NULL, it points to a struct that specifies the object version for which the state transitions are inquired. If the pointer is NULL, the "bSelectable" flags of all state transitions that involve pseudo-users will be true because transition rights cannot be checked in that case.

Remarks

This method is available only if M-Files API is used in the server interface mode.