json.schema.entity.classification.classification.json Maven / Gradle / Ivy
{
"$id": "https://open-metadata.org/schema/entity/classification/classification.json",
"$schema": "http://json-schema.org/draft-07/schema#",
"title": "Classification",
"description": "A `Classification` entity contains hierarchical terms called tags used for categorizing and classifying data assets and other entities.",
"type": "object",
"javaType": "org.openmetadata.schema.entity.classification.Classification",
"javaInterfaces": ["org.openmetadata.schema.EntityInterface"],
"properties": {
"id": {
"description": "Unique identifier of this entity instance.",
"$ref": "../../type/basic.json#/definitions/uuid"
},
"name": {
"$ref": "../../type/basic.json#/definitions/entityName"
},
"fullyQualifiedName": {
"description": "FullyQualifiedName same as `name`.",
"$ref": "../../type/basic.json#/definitions/fullyQualifiedEntityName"
},
"displayName": {
"description": "Display Name that identifies this entity.",
"type": "string"
},
"description": {
"description": "Description of the classification.",
"$ref": "../../type/basic.json#/definitions/markdown"
},
"version": {
"description": "Metadata version of the entity.",
"$ref": "../../type/entityHistory.json#/definitions/entityVersion"
},
"termCount" : {
"description": "Total number of children tag terms under this classification. This includes all the children in the hierarchy.",
"type" : "integer",
"minimum": 0
},
"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 the classification.",
"$ref": "../../type/basic.json#/definitions/href"
},
"usageCount": {
"description": "Count of how many times the tags from this classification are used.",
"type": "integer"
},
"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
},
"provider" : {
"$ref": "../../type/basic.json#/definitions/providerType"
},
"disabled" : {
"description": "System classifications can't be deleted. Use this flag to disable them.",
"type": "boolean"
},
"mutuallyExclusive" : {
"description" : "Tags under this classification are mutually exclusive. When mutually exclusive is `true` the tags from this classification are used to **classify** an entity. An entity can only be in one class - example, it can only be either `tier1` or `tier2` and not both. When mutually exclusive is `false`, the tags from this classification are used to **categorize** an entity. An entity have multiple tags simultaneously - example a customer can be `newCustomer` and `atRisk` simultaneously.",
"type" : "boolean",
"default" : "false"
},
"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": ["name", "description"],
"additionalProperties": false
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy