Skip to content

Class: metadata

Saved or custom views users to save or "bookmark" current searches, fileters, and other view settings.

AttributeMetadataDescription
labelType: String
Required
Max length: 50
UI-friendly string in the Vault's base language.
descriptionType: String
Max length: 255
A general description of the saved view.
tabType: ComponentThe tab where the saved view appears.
created_byType: String
Max length: 1500
The username of the user who created the saved view.
iconType: String
Max length: 1500
The icon that appears next to the saved view.
search_criteriaType: String
Max length: 32000
The filters that the saved view applies.
view_layoutType: String
Max length: 3000
The columns displayed for REPORTING (Tabular in UI) type layouts, including order and width information. Learn more about layout types in Vault Help.
mandatoryType: BooleanDetermines if the view is displayed in the Views section of the tab.
view_layout_typeType: Enum
Allowed values:
  • DETAIL
  • TILE
  • COMPACT
  • REPORTING
The layout type of the saved view.
search_criteria_listType: String
Max length: 32000
Multi-value
A serialized string representing a list of search criteria for each section of an expanded search.
collectionType: String
Max length: 1500
The name of the collection used on an expanded search being saved with the view.
report_layoutsType: String
Max length: 32000
The column positions and widths of an expanded search.
vql_search_criteriaType: String
Max length: 32000
The VQL expression that defines what Vault shows in the view.
managedType: BooleanInherits the value of mandatory. If true, the view can be included in configuration migration packages.
ownerType: String
Max length: 1500
The user who created the view.
statusType: String
Max length: 1500
If active, Vault shows the view in the View section of a tab.
grid_idType: String
Max length: 1500
For internal Veeva use only.
grid_locationType: String
Max length: 1500
For internal Veeva use only.
object_public_keyType: String
Max length: 1500
For internal Veeva use only.
view_typeType: String
Max length: 1500
For internal Veeva use only.
OperationSupport
Create
Recreate
Alter*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

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