Skip to content

Class: metadata

An object type is a collection of fields that are grouped to capture similar but not identical data within a single object.

Not all objects use object types. Learn about Object Types in Vault Help.

AttributeMetadataDescription
labelType: String
Required
Max length: 40
UI-friendly string in the Vault’s base language.
label_pluralType: String
Required
Max length: 40
Plural of the label in the Vault’s base language.
activeType: Boolean
Required
Indicates whether the object type is active.
descriptionType: String
Max length: 1000
A description of the object type that appears in the Admin UI to assist in object type configuration and is not visible to users.
additional_type_validationsType: String
Max length: 1500
Multi-value
Contains a list of all validation rules for the specified object type.
default_typeType: BooleanIf true, this is the default object type. Only one object type per object can be set to true. If no value is specified, the default value is false.
summary_fieldsType: String
Max length: 1500
Multi-value
Lists the fields to display in the Summary Info panel. For example, field_1__c,field_2__c. Learn more about configuring the Summary Info panel in Vault Help.

An object type is a collection of fields that are grouped to capture similar but not identical data within a single object.

AttributeMetadataDescription
sourceType: Enum
Required
Allowed values:
  • standard
  • sample
  • custom
  • application
  • system
The owner of the type. e.g. standard indicates owned by Vault.
requiredType: BooleanIndicates whether the user must always enter a value
relationship_criteriaType: Expression
Max length: 4000
The VQL used to constrain records in the referenced Object.
pickentriesType: String
Max length: 1500
Multi-value
The picklist values allowed for this field when the record is of this type. (Only valid for Fields of type Picklist)
default_valueType: String
Max length: 3900
The type specific default expression for the field.

An object type is a collection of fields that are grouped to capture similar but not identical data within a single object.

AttributeMetadataDescription
actionType: String
Required
Max length: 1500
The Objectaction allowed.
OperationSupport
Create
Recreate
Alter*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

  • Alter: MDL Operation may not be supported for some multi-value attributes.