Apache Atlas · JSON Structure

Atlas Atlas Entity Structure

Represents a single metadata entity in Apache Atlas.

Type: object Properties: 6
ApacheBig DataComplianceData GovernanceData LineageHadoopMetadataOpen Source

AtlasEntity is a JSON Structure definition published by Apache Atlas, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

typeName guid status attributes labels classifications

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-atlas/refs/heads/main/json-structure/atlas-atlas-entity-structure.json",
  "name": "AtlasEntity",
  "description": "Represents a single metadata entity in Apache Atlas.",
  "type": "object",
  "properties": {
    "typeName": {
      "type": "string",
      "description": "The type name of the entity.",
      "example": "DataSet"
    },
    "guid": {
      "type": "string",
      "description": "Globally unique identifier for the entity.",
      "example": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
    },
    "status": {
      "type": "string",
      "description": "Entity status (ACTIVE or DELETED).",
      "enum": [
        "ACTIVE",
        "DELETED"
      ],
      "example": "ACTIVE"
    },
    "attributes": {
      "type": "object",
      "description": "Map of attribute name to attribute value.",
      "example": {
        "name": "customer_data",
        "qualifiedName": "customer_data@prod"
      }
    },
    "labels": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Set of labels/tags applied to the entity.",
      "example": [
        "PII",
        "Finance"
      ]
    },
    "classifications": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "Classifications applied to the entity."
    }
  }
}