Autodesk Vault ProfessionalVault API

AddCustomEntityDefinition Method

Autodesk.Connectivity.WebServices›CustomEntityService

Adds a new Custom Entity Definition, which can be considered a Vault object type.

Required Permissions

CustomEntityDefCreate

Syntax

public CustEntDef AddCustomEntityDefinition(
   System.string name,
   System.string dispName,
   System.string dispNamePlural,
   ByteArray image,
   ACE[] acl
)
Public Function AddCustomEntityDefinition( _
   ByVal name As System.String, _
   ByVal dispName As System.String, _
   ByVal dispNamePlural As System.String, _
   ByVal image As ByteArray, _
   ByVal acl() As ACE _
) As CustEntDef

Parameters

NameDescription
nameThe system name of the entity definition. This must be a GUID with the following format (lower case): xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
dispNameThe display name to use when referring to a single object of this type. Must be unique.
dispNamePluralThe display name to use when referring to multiple objects of this type.
imageThe image to use with this definition. Must be the contents of an .ico file.
aclThe default security use use when creating new objects of this type.

Return Value

The Entity Definition object.

Remarks

Ideally the icon should contain the following 4 sizes: 16x16, 32x32, 64x64, and 128x128

See Also