yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-07-12 19:48:26 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.6.x-SNAPSHOT/main-concepts/metadata-standard/schemas/api/data/createDashboard.md
Pere Miquel Brull 60ed221cf1
DOCS - Update Version Snapshots (#17589)
2024-08-27 14:41:12 +05:30

2.3 KiB
Raw Blame History

title slug
createDashboard /main-concepts/metadata-standard/schemas/api/data/createdashboard

CreateDashboardRequest

Create Dashboard entity request

Properties

  • 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.
  • description: Description of the database instance. What it has and how to use it. Refer to ../../type/basic.json#/definitions/markdown.
  • dashboardType: Refer to ../../entity/data/dashboard.json#/definitions/dashboardType.
  • sourceUrl: Dashboard URL suffix from its service. Refer to ../../type/basic.json#/definitions/sourceUrl.
  • project (string): Name of the project / workspace / collection in which the dashboard is contained.
  • charts (array): List of fully qualified name of charts included in this Dashboard. Default: None.
    • Items: Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • dataModels (array): List of fully qualified name of data models included in this Dashboard. Default: None.
    • Items: Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • tags (array): Tags for this dashboard. Default: None.
    • Items: Refer to ../../type/tagLabel.json.
  • owner: Owner of this dashboard. Refer to ../../type/entityReference.json.
  • service: Link to the dashboard service fully qualified name where this dashboard is hosted in. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • extension: Entity extension data with custom attributes added to the entity. Refer to ../../type/basic.json#/definitions/entityExtension.
  • domain: Fully qualified name of the domain the Dashboard belongs to. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • dataProducts (array): List of fully qualified names of data products this entity is part of.
    • Items: Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • lifeCycle: Life Cycle of the entity. Refer to ../../type/lifeCycle.json.

Documentation file automatically generated at 2023-10-27 13:55:46.343512.