OpenMetadata · Schema

Changeevent

Data CatalogMetadataData GovernanceData LineageData QualityOpen SourceData DiscoveryData Observability

Properties

Name	Type	Description
id	string
eventType	string
entityType	string
entityId	string
domains	array
entityFullyQualifiedName	string
previousVersion	number
currentVersion	number
userName	string
impersonatedBy	string
timestamp	integer
changeDescription	object
incrementalChangeDescription	object
entity	object

View JSON Schema on GitHub

JSON Schema

{
  "required": [
    "entityId",
    "entityType",
    "eventType",
    "id",
    "timestamp"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid"
    },
    "eventType": {
      "type": "string",
      "enum": [
        "entityCreated",
        "entityUpdated",
        "entityFieldsChanged",
        "entityNoChange",
        "entitySoftDeleted",
        "entityDeleted",
        "entityRestored",
        "threadCreated",
        "threadUpdated",
        "postCreated",
        "postUpdated",
        "taskResolved",
        "taskClosed",
        "logicalTestCaseAdded",
        "suggestionCreated",
        "suggestionUpdated",
        "suggestionAccepted",
        "suggestionRejected",
        "suggestionDeleted",
        "userLogin",
        "userLogout"
      ]
    },
    "entityType": {
      "type": "string"
    },
    "entityId": {
      "type": "string",
      "format": "uuid"
    },
    "domains": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uuid"
      }
    },
    "entityFullyQualifiedName": {
      "type": "string"
    },
    "previousVersion": {
      "type": "number",
      "format": "double"
    },
    "currentVersion": {
      "type": "number",
      "format": "double"
    },
    "userName": {
      "type": "string"
    },
    "impersonatedBy": {
      "type": "string"
    },
    "timestamp": {
      "type": "integer",
      "format": "int64"
    },
    "changeDescription": {
      "$ref": "#/components/schemas/ChangeDescription"
    },
    "incrementalChangeDescription": {
      "$ref": "#/components/schemas/ChangeDescription"
    },
    "entity": {
      "type": "object"
    }
  },
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/openmetadata/main/json-schema/changeevent.json"
}