Autodesk Vault ProfessionalVault API

UpdateLifeCycleState Method

Autodesk.Connectivity.WebServices›LifeCycleService

Updates a Life Cycle State.

Required Permissions

ManageBehaviorDefinition

Syntax

public LfCycState UpdateLifeCycleState(
   System.long stateId,
   System.string displayName,
   System.string description,
   System.int color,
   System.bool isDefault,
   System.bool useStateBasedSecurity,
   System.string[] comments,
   ACE[] entries,
   System.bool isReleasedState,
   System.bool isObsoleteState,
   System.int displayOrder,
   RestrictPurgeOption restrictPurgeOption,
   ItemToFileSecurityModeEnum itemToFileLinkSecurityMode,
   ACE[] itemToFileLinkSecurityEntries,
   FolderFileSecurityModeEnum folderFileSecurityMode,
   ACE[] folderFileSecurityEntries
)
Public Function UpdateLifeCycleState( _
   ByVal stateId As System.Long, _
   ByVal displayName As System.String, _
   ByVal description As System.String, _
   ByVal color As System.Integer, _
   ByVal isDefault As System.Boolean, _
   ByVal useStateBasedSecurity As System.Boolean, _
   ByVal comments() As System.String, _
   ByVal entries() As ACE, _
   ByVal isReleasedState As System.Boolean, _
   ByVal isObsoleteState As System.Boolean, _
   ByVal displayOrder As System.Integer, _
   ByVal restrictPurgeOption As RestrictPurgeOption, _
   ByVal itemToFileLinkSecurityMode As ItemToFileSecurityModeEnum, _
   ByVal itemToFileLinkSecurityEntries() As ACE, _
   ByVal folderFileSecurityMode As FolderFileSecurityModeEnum, _
   ByVal folderFileSecurityEntries() As ACE _
) As LfCycState

Parameters

NameDescription
stateIdThe ID of the life cycle state.
displayNameThe new display name.
descriptionThe new description.
colorThe new color.
isDefaultIf true, the state is the default state within the life cycle definition.
useStateBasedSecurityIf true, state based security is to be used for files in this state.
commentsThe new comment array. The existing array is overwritten.
entriesSecurity information.
isReleasedStateIf true, files in this state are considered released.
isObsoleteStateidentifies whether this state is an obsolete state
displayOrderdisplay order of the state within its life cycle definition
restrictPurgeOptionIf true, entities in this state are not deleted during a purge operation.
itemToFileLinkSecurityModeflag identifying the state security control of an item's file links
itemToFileLinkSecurityEntriesACL used when itemToFileLinkSecurityMode is set to "ApplyACL"
folderFileSecurityModeFlag identifying the State security control of files contained in a Folder. Applied on a Folder State change (if configured)
folderFileSecurityEntriesACL used when folderFileSecurityMode is set to "ApplyACL"

Return Value

The updated life cycle state object.

See Also