Skip to content

Class: metadata

Dashboards provide an at-a-glance understanding of key metrics.

AttributeMetadataDescription
activeType: BooleanIndicates whether the component is active.
labelType: String
Required
Max length: 128
UI-friendly string in the Vault's base language.
descriptionType: String
Max length: 255
A general description of the dashboard.
editorsType: String
Max length: 300
Multi-value
Users with the Editor permission required to edit dashboards.
viewersType: String
Max length: 300
Multi-value
Users with the Viewer permission required to view dashboards.
ownersType: String
Max length: 300
Multi-value
Lists users and groups in the Owner role. Users in this role can assign other users and groups to the Owner role on Dashboards.
dashboard_markupType: XMLString
Required
Max length: 32000
Describes the layout of the dashboard.
tagsType: String
Max length: 1500
Multi-value
A list of tags associated with the dashboard.
OperationSupport
Create*
Recreate*
Alter*
Drop
Rename
Describe
Generate Recreate
Queryable

Notes:

  • Create, Recreate, Alter: MDL Operation is supported, but the Component Type contains field(s) that use proprietary XML. Direct modification of the XML is not supported or recommended. Instead, creating and/or updating the component is better suited through the Admin UI.
  • Alter: MDL Operation may not be supported for some multi-value attributes.