Autodesk Vault ProfessionalVault API

AddLifeCycleState Method

Autodesk.Connectivity.WebServicesLifeCycleService

Adds a new lifecycle state.

Required Permissions

ManageBehaviorDefinition

Syntax

public LfCycState AddLifeCycleState(
   System.long lcDefId,
   System.string systemName,
   System.string displayName,
   System.string description,
   System.int color,
   System.bool isDefault,
   System.bool useStateBasedSecurity,
   ACE[] entries,
   System.string[] comments,
   System.bool isReleasedState,
   System.bool isObsoleteState,
   System.int displayOrder,
   RestrictPurgeOption restrictPurgeOption,
   ItemToFileSecurityModeEnum itemToFileLinkSecurityMode,
   ACE[] itemToFileLinkSecurityEntries,
   FolderFileSecurityModeEnum folderFileSecurityMode,
   ACE[] folderFileSecurityEntries
)
Public Function AddLifeCycleState( _
   ByVal lcDefId As System.Long, _
   ByVal systemName As System.String, _
   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 entries() As ACE, _
   ByVal comments() As System.String, _
   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
lcDefIdThe Life Cycle Definition to add the state to.
systemNameThe system name of the Life Cycle State. This value must be a GUID with the following format (lower case): xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
displayNameThe display name of the state.
descriptionA description of the state.
colorThe color of the state.
isDefaultIf true, this is the default state for the Life Cycle Definition. Each definition can have only one default state.
useStateBasedSecurityIf true, security is enabled for this state.
entriesThe ACL data for this state. Only valid if 'useStateBasedSecurity' is true.
commentsComments for this state.
isReleasedStateIf true, objects in this state are considered released. A Life Cycle Definition can have any number of released states.
isObsoleteStateidentifies whether this state is an obsolete state
displayOrderdisplay order of this state within its life cycle definition
restrictPurgeOptionTells which versions in this state are restricted from deletion during a Purge operation.
itemToFileLinkSecurityModeflag identifying the state security control of an item's file links
itemToFileLinkSecurityEntriesACL used when itemToFileSecurityLinkSecurityMode 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 object for this Life Cycle State.

See Also