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

Chart

Chart

This schema defines the Chart entity. Charts are built using tables or sql queries by analyzing the data. Charts can be part of Dashboard.

$id:https://open-metadata.org/schema/entity/data/chart.json

Type: object

This schema does not accept additional properties.

Properties

<<<<<<< HEAD

• id required
  • Unique identifier that identifies a chart instance.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • Name that identifies this Chart.
  • Type: string
  • Length: between 1 and 128
• displayName
  • Display Name that identifies this Chart. It could be title or label from the source services.
  • Type: string
• fullyQualifiedName
  • A unique name that identifies a dashboard in the format 'ServiceName.ChartName'.
  • Type: string
  • Length: between 1 and 256
• description
  • Description of the dashboard, what it is, and how to use it.
  • 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
• chartType
  • $ref: #/definitions/chartType
• chartUrl
  • Chart URL, pointing to its own Service URL.
  • Type: string
  • String format must be a "uri"
• href
  • Link to the resource corresponding to this entity.
  • $ref: ../../type/basic.json#/definitions/href
• owner
  • Owner of this dashboard.
  • $ref: ../../type/entityReference.json
• tables
  • Link to table used in this chart.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• followers
  • Followers of this chart.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• tags
  • Tags for this chart.
  • Type: array
    • Items
    • $ref: ../../type/tagLabel.json
• service required
  • Link to service where this dashboard is hosted in.
  • $ref: ../../type/entityReference.json
• serviceType
  • Service type where this chart is hosted in.
  • $ref: ../services/dashboardService.json#/definitions/dashboardServiceType
• usageSummary
  • Latest usage information for this database.
  • $ref: ../../type/usageDetails.json
• 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

a07bc411 (updated json schema and schema docs (#3219))

• id required
  • Unique identifier that identifies a chart instance.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • Name that identifies this Chart.
  • Type: string
  • Length: between 1 and 128
• displayName
  • Display Name that identifies this Chart. It could be title or label from the source services.
  • Type: string
• fullyQualifiedName
  • A unique name that identifies a dashboard in the format 'ServiceName.ChartName'.
  • Type: string
  • Length: between 1 and 256
• description
  • Description of the dashboard, what it is, and how to use it.
  • 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
• chartType
  • $ref: #/definitions/chartType
• chartUrl
  • Chart URL, pointing to its own Service URL.
  • Type: string
  • String format must be a "uri"
• href
  • Link to the resource corresponding to this entity.
  • $ref: ../../type/basic.json#/definitions/href
• owner
  • Owner of this dashboard.
  • $ref: ../../type/entityReference.json
• tables
  • Link to table used in this chart.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• followers
  • Followers of this chart.
  • $ref: ../../type/entityReference.json#/definitions/entityReferenceList
• tags
  • Tags for this chart.
  • Type: array
    • Items
    • $ref: ../../type/tagLabel.json
• service required
  • Link to service where this dashboard is hosted in.
  • $ref: ../../type/entityReference.json
• serviceType
  • Service type where this chart is hosted in.
  • $ref: ../services/dashboardService.json#/definitions/dashboardServiceType
• usageSummary
  • Latest usage information for this database.
  • $ref: ../../type/usageDetails.json
• 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

chartType

• This schema defines the type used for describing different types of charts.
• Type: string
• The value is restricted to the following:
  1. "Line"
  2. "Table"
  3. "Bar"
  4. "Area"
  5. "Pie"
  6. "Histogram"
  7. "Scatter"
  8. "Text"
  9. "BoxPlot"
  10. "Other"

<<<<<<< HEAD This document was updated on: Tuesday, January 25, 2022

This document was updated on: Monday, March 7, 2022

a07bc411 (updated json schema and schema docs (#3219))