We use cookies to improve site navigation, analyze site usage, and enhance your user experience. Click "Accept" to enable cookies or "Reject" to reject cookies.

main-concepts

No menu items for this category
Home/Main Concepts/Metadata Standard/Schemas/Api/Data/Createdashboard
OpenMetadata Documentation

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.
  • owners: Owners of this dashboard. Refer to ../../type/entityReferenceList.json. Default: None.
  • 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.
  • domains (array): Fully qualified names of the domains the Dashboard belongs to.
    • Items: 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.
  • sourceHash (string): Source hash of the entity.

Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.