mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-12-15 17:46:39 +00:00
69342d4783
* Updated generate_docs_schema * Updated generate_docs_schema * Updated generate_docs_schema * applied generate_docs_schema script * Revert the changes in this file --------- Co-authored-by: Tarun <tarun.p@deuexsolutions.com> Co-authored-by: Prajwal214 <167504578+Prajwal214@users.noreply.github.com>
4.9 KiB
4.9 KiB
| title | slug |
|---|---|
| dashboard | /main-concepts/metadata-standard/schemas/entity/data/dashboard |
Dashboard
This schema defines the Dashboard entity. Dashboards are computed from data and visually present data, metrics, and KPIs. They are typically updated in real-time and allow interactive data exploration.
Properties
id: Unique identifier that identifies a dashboard instance. Refer to ../../type/basic.json#/definitions/uuid.name: Name that identifies this dashboard. Refer to ../../type/basic.json#/definitions/entityName.displayName(string): Display Name that identifies this Dashboard. It could be title or label from the source services.fullyQualifiedName: A unique name that identifies a dashboard in the format 'ServiceName.DashboardName'. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.description: Description of the dashboard, what it is, and how to use it. Refer to ../../type/basic.json#/definitions/markdown.project(string): Name of the project / workspace / collection in which the dashboard is contained.version: Metadata version of the entity. Refer to ../../type/entityHistory.json#/definitions/entityVersion.updatedAt: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to ../../type/basic.json#/definitions/timestamp.updatedBy(string): User who made the update.dashboardType: Refer to #/definitions/dashboardType.sourceUrl: Dashboard URL suffix from its service. Refer to ../../type/basic.json#/definitions/sourceUrl.charts: All the charts included in this Dashboard. Refer to ../../type/entityReferenceList.json. Default:null.dataModels: List of data models used by this dashboard or the charts contained on it. Refer to ../../type/entityReferenceList.json. Default:null.href: Link to the resource corresponding to this entity. Refer to ../../type/basic.json#/definitions/href.owners: Owners of this dashboard. Refer to ../../type/entityReferenceList.json.followers: Followers of this dashboard. Refer to ../../type/entityReferenceList.json.tags(array): Tags for this dashboard. Default:[].- Items: Refer to ../../type/tagLabel.json.
service: Link to service where this dashboard is hosted in. Refer to ../../type/entityReference.json.serviceType: Service type where this dashboard is hosted in. Refer to ../services/dashboardService.json#/definitions/dashboardServiceType.usageSummary: Latest usage information for this dashboard. Refer to ../../type/usageDetails.json. Default:null.changeDescription: Change that lead to this version of the entity. Refer to ../../type/entityHistory.json#/definitions/changeDescription.deleted(boolean): Whentrueindicates the entity has been soft deleted. Default:false.extension: Entity extension data with custom attributes added to the entity. Refer to ../../type/basic.json#/definitions/entityExtension.domain: Domain the Dashboard belongs to. When not set, the Dashboard inherits the domain from the dashboard service it belongs to. Refer to ../../type/entityReference.json.dataProducts: List of data products this entity is part of. Refer to ../../type/entityReferenceList.json.votes: Votes on the entity. Refer to ../../type/votes.json.lifeCycle: Life Cycle properties of the entity. Refer to ../../type/lifeCycle.json.certification: Refer to ../../type/assetCertification.json.sourceHash(string): Source hash of the entity.
Definitions
dashboardType(string): This schema defines the type used for describing different types of dashboards. Must be one of:["Dashboard", "Report"]. Default:"Dashboard".
Documentation file automatically generated at 2025-01-15 09:05:25.266839+00:00.