Autodesk Vault ProfessionalVault API

AddLifeCycleStateTransition Method

Autodesk.Connectivity.WebServicesLifeCycleService

Adds a transition from one Life Cycle State to another.

Required Permissions

ManageBehaviorDefinition

Syntax

public LfCycTrans AddLifeCycleStateTransition(
   System.long fromStateId,
   System.long toStateId,
   EnforceChildStateEnum enforceChildState,
   EnforceContentStateEnum enforceContentState,
   BumpRevisionEnum bumpRevision,
   JobSyncPropEnum syncPropOption,
   FileLinkTypeEnum enforceFileLinkUptodate,
   FileLinkTypeEnum enforceFileLinkConsumable,
   System.bool enforceChildNotObsoleteState,
   System.bool useTransitionBasedSecurity,
   System.long[] allowedUserIds,
   System.long[] deniedUserIds,
   PropDefCond[] conditions,
   RuleSet[] peerReviewRuleSets,
   System.bool updateItems,
   System.bool executePurge
)
Public Function AddLifeCycleStateTransition( _
   ByVal fromStateId As System.Long, _
   ByVal toStateId As System.Long, _
   ByVal enforceChildState As EnforceChildStateEnum, _
   ByVal enforceContentState As EnforceContentStateEnum, _
   ByVal bumpRevision As BumpRevisionEnum, _
   ByVal syncPropOption As JobSyncPropEnum, _
   ByVal enforceFileLinkUptodate As FileLinkTypeEnum, _
   ByVal enforceFileLinkConsumable As FileLinkTypeEnum, _
   ByVal enforceChildNotObsoleteState As System.Boolean, _
   ByVal useTransitionBasedSecurity As System.Boolean, _
   ByVal allowedUserIds() As System.Long, _
   ByVal deniedUserIds() As System.Long, _
   ByVal conditions() As PropDefCond, _
   ByVal peerReviewRuleSets() As RuleSet, _
   ByVal updateItems As System.Boolean, _
   ByVal executePurge As System.Boolean _
) As LfCycTrans

Parameters

NameDescription
fromStateIdThe starting state.
toStateIdThe destination state.
enforceChildStateA bitfield indicating how the state should be enforced in associated child Entities.
enforceContentStateA bitfield indicating how the state should be enforced in linked Entities.
bumpRevisionIf true, the object revision should be bumped during the transition. If false, the object revision will stay the same.
syncPropOptionThis option tells if the 'state' property needs to be synchronized with the file during a state change. Has no affect on other entity types.
enforceFileLinkUptodatesets an action on this transition to verify that an item's file links are up-to-date
enforceFileLinkConsumablesets an action on this transition to verify that an item's file links are in a consumable state
enforceChildNotObsoleteStatespecifies whether or not to verify that there are no children in the obsolete state for this transition
useTransitionBasedSecurityIf true, security is enabled for this transition.
allowedUserIdsThe users and groups allowed to use this transition.
deniedUserIdsThe users and groups restricted from using this transition.
conditionsA set of property conditions for this transition. A transition cannot occur if the conditions have not been met.
peerReviewRuleSets
updateItemsFor future use. Pass false for now.
executePurge

Return Value

The new Life Cycle Transition object.

See Also