Microsoft Purview · Schema

Microsoft Purview Glossary Term

Represents a business glossary term in the Microsoft Purview Data Map. Glossary terms provide standardized business vocabulary for data governance.

ComplianceData CatalogData ClassificationData GovernanceData Loss PreventionInformation Protection

Properties

Name Type Description
guid string The globally unique identifier of the glossary term
qualifiedName string The fully qualified name of the glossary term
name string The display name of the glossary term
shortDescription string A brief description of the term
longDescription string A detailed description of the term
abbreviation string The abbreviation of the term
usage string Usage guidance for the term
status string The approval status of the term
anchor object Reference to the parent glossary
categories array Categories the term belongs to
classifications array Classifications applied to the term
assignedEntities array Entities assigned to this term
seeAlso array Related glossary terms
synonyms array Synonym terms
antonyms array Antonym terms
resources array External resources related to the term
contacts object Contact information for the term
View JSON Schema on GitHub

JSON Schema

microsoft-purview-glossary-term-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://github.com/api-search/microsoft-purview/json-schema/microsoft-purview-glossary-term-schema.json",
  "title": "Microsoft Purview Glossary Term",
  "description": "Represents a business glossary term in the Microsoft Purview Data Map. Glossary terms provide standardized business vocabulary for data governance.",
  "type": "object",
  "properties": {
    "guid": {
      "type": "string",
      "format": "uuid",
      "description": "The globally unique identifier of the glossary term"
    },
    "qualifiedName": {
      "type": "string",
      "description": "The fully qualified name of the glossary term"
    },
    "name": {
      "type": "string",
      "description": "The display name of the glossary term"
    },
    "shortDescription": {
      "type": "string",
      "description": "A brief description of the term"
    },
    "longDescription": {
      "type": "string",
      "description": "A detailed description of the term"
    },
    "abbreviation": {
      "type": "string",
      "description": "The abbreviation of the term"
    },
    "usage": {
      "type": "string",
      "description": "Usage guidance for the term"
    },
    "status": {
      "type": "string",
      "description": "The approval status of the term",
      "enum": ["Draft", "Approved", "Alert", "Expired"]
    },
    "anchor": {
      "type": "object",
      "description": "Reference to the parent glossary",
      "properties": {
        "displayText": {
          "type": "string"
        },
        "glossaryGuid": {
          "type": "string",
          "format": "uuid"
        },
        "relationGuid": {
          "type": "string",
          "format": "uuid"
        }
      }
    },
    "categories": {
      "type": "array",
      "description": "Categories the term belongs to",
      "items": {
        "type": "object",
        "properties": {
          "categoryGuid": {
            "type": "string",
            "format": "uuid"
          },
          "description": {
            "type": "string"
          },
          "displayText": {
            "type": "string"
          },
          "relationGuid": {
            "type": "string",
            "format": "uuid"
          },
          "status": {
            "type": "string"
          }
        }
      }
    },
    "classifications": {
      "type": "array",
      "description": "Classifications applied to the term",
      "items": {
        "type": "object",
        "properties": {
          "typeName": {
            "type": "string"
          },
          "attributes": {
            "type": "object",
            "additionalProperties": true
          }
        }
      }
    },
    "assignedEntities": {
      "type": "array",
      "description": "Entities assigned to this term",
      "items": {
        "type": "object",
        "properties": {
          "displayText": {
            "type": "string"
          },
          "guid": {
            "type": "string",
            "format": "uuid"
          },
          "typeName": {
            "type": "string"
          },
          "relationshipGuid": {
            "type": "string",
            "format": "uuid"
          },
          "relationshipStatus": {
            "type": "string",
            "enum": ["ACTIVE", "DELETED"]
          }
        }
      }
    },
    "seeAlso": {
      "type": "array",
      "description": "Related glossary terms",
      "items": {
        "type": "object",
        "properties": {
          "displayText": {
            "type": "string"
          },
          "termGuid": {
            "type": "string",
            "format": "uuid"
          },
          "relationGuid": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    },
    "synonyms": {
      "type": "array",
      "description": "Synonym terms",
      "items": {
        "type": "object",
        "properties": {
          "displayText": {
            "type": "string"
          },
          "termGuid": {
            "type": "string",
            "format": "uuid"
          },
          "relationGuid": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    },
    "antonyms": {
      "type": "array",
      "description": "Antonym terms",
      "items": {
        "type": "object",
        "properties": {
          "displayText": {
            "type": "string"
          },
          "termGuid": {
            "type": "string",
            "format": "uuid"
          },
          "relationGuid": {
            "type": "string",
            "format": "uuid"
          }
        }
      }
    },
    "resources": {
      "type": "array",
      "description": "External resources related to the term",
      "items": {
        "type": "object",
        "properties": {
          "displayName": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "format": "uri"
          }
        }
      }
    },
    "contacts": {
      "type": "object",
      "description": "Contact information for the term",
      "properties": {
        "expert": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": { "type": "string" },
              "info": { "type": "string" }
            }
          }
        },
        "steward": {
          "type": "array",
          "items": {
            "type": "object",
            "properties": {
              "id": { "type": "string" },
              "info": { "type": "string" }
            }
          }
        }
      }
    }
  },
  "required": ["name"]
}