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

  • id: Unique identifier that identifies this report. Refer to ../../type/basic.json#/definitions/uuid.
  • name: Name that identifies this report instance uniquely. Refer to ../../type/basic.json#/definitions/entityName.
  • fullyQualifiedName: A unique name that identifies a report in the format 'ServiceName.ReportName'. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • displayName (string): Display Name that identifies this report. It could be title or label from the source services.
  • description: Description of this report instance. Refer to ../../type/basic.json#/definitions/markdown.
  • version: Metadata version of the entity. Refer to ../../type/entityHistory.json#/definitions/entityVersion.
  • updatedAt: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to ../../type/basic.json#/definitions/timestamp.
  • updatedBy (string): User who made the update.
  • href: Link to the resource corresponding to this report. Refer to ../../type/basic.json#/definitions/href.
  • owner: Owner of this pipeline. Refer to ../../type/entityReference.json.
  • service: Link to service where this report is hosted in. Refer to ../../type/entityReference.json.
  • usageSummary: Latest usage information for this database. Refer to ../../type/usageDetails.json. Default: None.
  • changeDescription: Change that lead to this version of the entity. Refer to ../../type/entityHistory.json#/definitions/changeDescription.
  • deleted (boolean): When true indicates the entity has been soft deleted. Default: False.

Documentation file automatically generated at 2022-07-14 10:51:34.749986.

Still have questions?

You can take a look at our Q&A or reach out to us in Slack

Was this page helpful?

editSuggest edits