CustomObject

The CustomObject object is of type Autodesk.DataManagement.Client.Framework.Vault.Currency.Entities.CustomObject and grants direct access to the Vault custom Object where the Job is triggered on.

Syntax

1
$customObject.Definition

Following properties are available :

Type

Name

Description

Access type

Category

Gets the category that is assigned to this Custom Object.

read-only

Definition

Gets the Custom Object Definition which contains specifics about the type of custom object this is

read-only

EntityClass

Gets the entity class associated with this CustomObject.

read-only

long

EntityIterationId

Gets the Iteration ID of this Change Order. Since Change Orders are not iteration based, this will always have the same value as the EntityMasterId.

read-only

long

EntityMasterId

Gets the Master Id of this Change Order. The Master Id uniquely identifies this Change Order object

read-only

string

EntityName

Gets the descriptive name for this Custom Object.

read-only

bool

IsCloaked

Gets if this Custom Object is cloaked. A cloaked object is one that the caller does not have permissions to view.

read-only

LinkInfo

Gets if this is a Link to a Custom Object. If the value is not null, then LinkInfo provides information about the Link to this CustomObject.

read-only

VaultConnection

Gets the associated Vault Connection for this ChangeOrder.

read-only

Remarks

The $customObject variable is available when a Job is triggered with these parameters:

  • EntityClassId = CUSTENT

  • EntityId = <Id of the custom entity>

Also the LifecycleEventEditor triggers the Job with this parameters.

All the properties of the CustomObject object are part of the Vault API.
You can look them up in the VaultSDK documentation under CustomObject Class Members.