json.schema.entity.data.report.json Maven / Gradle / Ivy
{
"$id": "https://open-metadata.org/schema/entity/data/report.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Report",
"description": "This schema defines the Report entity. `Reports` are static information computed from data periodically that includes data in text, table, and visual form.",
"type": "object",
"javaType": "org.openmetadata.schema.entity.data.Report",
"javaInterfaces": ["org.openmetadata.schema.EntityInterface"],
"properties": {
"id": {
"description": "Unique identifier that identifies this report.",
"$ref": "../../type/basic.json#/definitions/uuid"
},
"name": {
"description": "Name that identifies this report instance uniquely.",
"$ref": "../../type/basic.json#/definitions/entityName"
},
"fullyQualifiedName": {
"description": "A unique name that identifies a report in the format 'ServiceName.ReportName'.",
"$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
},
"displayName": {
"description": "Display Name that identifies this report. It could be title or label from the source services.",
"type": "string"
},
"description": {
"description": "Description of this report instance.",
"$ref": "../../type/basic.json#/definitions/markdown"
},
"version": {
"description": "Metadata version of the entity.",
"$ref": "../../type/entityHistory.json#/definitions/entityVersion"
},
"updatedAt": {
"description": "Last update time corresponding to the new version of the entity in Unix epoch time milliseconds.",
"$ref": "../../type/basic.json#/definitions/timestamp"
},
"updatedBy": {
"description": "User who made the update.",
"type": "string"
},
"href": {
"description": "Link to the resource corresponding to this report.",
"$ref": "../../type/basic.json#/definitions/href"
},
"owners": {
"description": "Owners of this Report.",
"$ref": "../../type/entityReferenceList.json"
},
"service": {
"description": "Link to service where this report is hosted in.",
"$ref": "../../type/entityReference.json"
},
"usageSummary": {
"description": "Latest usage information for this database.",
"$ref": "../../type/usageDetails.json",
"default": null
},
"changeDescription": {
"description": "Change that lead to this version of the entity.",
"$ref": "../../type/entityHistory.json#/definitions/changeDescription"
},
"deleted": {
"description": "When `true` indicates the entity has been soft deleted.",
"type": "boolean",
"default": false
},
"votes" : {
"description": "Votes on the entity.",
"$ref": "../../type/votes.json"
},
"domain" : {
"description": "Domain the asset belongs to. When not set, the asset inherits the domain from the parent it belongs to.",
"$ref": "../../type/entityReference.json"
}
},
"required": ["id", "name", "service"],
"additionalProperties": false
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy