Autodesk Vault ProfessionalVault API

AddPropertyDefinition Method

Autodesk.Connectivity.WebServicesPropertyService

Adds a property definition.

Required Permissions

ManagePropertyDefinition

Syntax

public PropDefInfo AddPropertyDefinition(
   System.string systemName,
   System.string displayName,
   DataType dataType,
   System.bool isBasicSearchEnabled,
   System.bool isActive,
   System.object defaultValue,
   System.string[] mappedEntityClassIds,
   EntClassCtntSrcPropCfg[] entityClassCtntSrcPropDefs,
   PropConstr[] baseConstraints,
   System.object[] listValues
)
Public Function AddPropertyDefinition( _
   ByVal systemName As System.String, _
   ByVal displayName As System.String, _
   ByVal dataType As DataType, _
   ByVal isBasicSearchEnabled As System.Boolean, _
   ByVal isActive As System.Boolean, _
   ByVal defaultValue As System.Object, _
   ByVal mappedEntityClassIds() As System.String, _
   ByVal entityClassCtntSrcPropDefs() As EntClassCtntSrcPropCfg, _
   ByVal baseConstraints() As PropConstr, _
   ByVal listValues() As System.Object _
) As PropDefInfo

Parameters

NameDescription
systemNameThe system name of the Property Definition. This value must be a GUID with the following format (lower case): xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
displayNameThe display name.
dataTypeThe data type.
isBasicSearchEnabledIf true, these property values are included for basic searches. If false, the property values are not searched during a basic search.
isActiveIf true, the property definition is active.
defaultValueThe default value.
mappedEntityClassIdsA list of entity types that the property definition can be used with.
entityClassCtntSrcPropDefsThe mappings to content source properties. Must be the same size as 'mappedEntityClassIds'.
baseConstraintsThe base constraints. These values can be overwritten on a per-Category basis.
listValuesA list of legal values for the property. A null value means that any value can be used. Only applies to String and Numeric types.

Return Value

The new Property Definition object and related information.

See Also