OpenMetadata/docs/openmetadata-apis/schemas/entities/dashboardservice.md

Dashboard Service

This schema defines the Dashboard Service entity, such as Looker and Superset.

$id:https://open-metadata.org/schema/entity/services/dashboardService.json

Type: object

This schema does not accept additional properties.

Properties

• id required
  • Unique identifier of this dashboard service instance.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • Name that identifies this dashboard service.
  • Type: string
  • The value must match this pattern: ^[^.]*$
  • Length: between 1 and 128
• displayName
  • Display Name that identifies this dashboard service.
  • Type: string
• serviceType required
  • Type of dashboard service such as Looker or Superset...
  • $ref: #/definitions/dashboardServiceType
• description
  • Description of a dashboard service instance.
  • Type: string
• version
  • Metadata version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/entityVersion
• updatedAt
  • Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.
  • $ref: ../../type/basic.json#/definitions/timestamp
• updatedBy
  • User who made the update.
  • Type: string
• owner
  • Owner of this dashboard service.
  • $ref: ../../type/entityReference.json
• dashboardUrl required
  • Dashboard Service URL. This will be used to make REST API calls to Dashboard Service.
  • Type: string
  • String format must be a "uri"
• username
  • Username to log-into Dashboard Service.
  • Type: string
• password
  • Password to log-into Dashboard Service.
  • Type: string
• ingestionSchedule
  • Schedule for running metadata ingestion jobs.
  • $ref: ../../type/schedule.json
• href
  • Link to the resource corresponding to this dashboard service.
  • $ref: ../../type/basic.json#/definitions/href
• changeDescription
  • Change that lead to this version of the entity.
  • $ref: ../../type/entityHistory.json#/definitions/changeDescription
• deleted
  • When true indicates the entity has been soft deleted.
  • Type: boolean
  • Default: false

Type definitions in this schema

dashboardServiceType

• Type of Dashboard service - Superset, Looker, Redash or Tableau.
• Type: string
• The value is restricted to the following:
  1. "Superset"
  2. "Looker"
  3. "Tableau"
  4. "Redash"
  5. "Metabase"
  6. "PowerBI"

This document was updated on: Wednesday, March 9, 2022