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

Report

This schema defines the Report entity. Reports are static information computed from data periodically that includes data in text, table, and visual form.

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

Type: object

This schema does not accept additional properties.

Properties

• id required
  • Unique identifier that identifies this report.
  • $ref: ../../type/basic.json#/definitions/uuid
• name required
  • Name that identifies this report instance uniquely.
  • Type: string
  • Length: between 1 and 128
• fullyQualifiedName
  • A unique name that identifies a report in the format 'ServiceName.ReportName'.
  • Type: string
  • Length: between 1 and 256
• displayName
  • Display Name that identifies this report. It could be title or label from the source services.
  • Type: string
• description
  • Description of this report 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
• href
  • Link to the resource corresponding to this report.
  • $ref: ../../type/basic.json#/definitions/href
• owner
  • Owner of this pipeline.
  • $ref: ../../type/entityReference.json
• service required
  • Link to service where this report is hosted in.
  • $ref: ../../type/entityReference.json
• 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

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