Apache Atlas · Schema

AtlasRelationship

A relationship between two Atlas entities.

ApacheBig DataComplianceData GovernanceData LineageHadoopMetadataOpen Source

Properties

Name	Type	Description
guid	string	GUID of the relationship.
typeName	string	Type name of the relationship.
status	string	Status of the relationship.
end1	object	First endpoint of the relationship.
end2	object	Second endpoint of the relationship.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-atlas/refs/heads/main/json-schema/atlas-atlas-relationship-schema.json",
  "title": "AtlasRelationship",
  "description": "A relationship between two Atlas entities.",
  "type": "object",
  "properties": {
    "guid": {
      "type": "string",
      "description": "GUID of the relationship.",
      "example": "rel-guid-001"
    },
    "typeName": {
      "type": "string",
      "description": "Type name of the relationship.",
      "example": "DataSetLineage"
    },
    "status": {
      "type": "string",
      "description": "Status of the relationship.",
      "enum": [
        "ACTIVE",
        "DELETED"
      ],
      "example": "ACTIVE"
    },
    "end1": {
      "type": "object",
      "description": "First endpoint of the relationship.",
      "properties": {
        "guid": {
          "type": "string",
          "example": "source-entity-guid"
        },
        "typeName": {
          "type": "string",
          "example": "DataSet"
        }
      }
    },
    "end2": {
      "type": "object",
      "description": "Second endpoint of the relationship.",
      "properties": {
        "guid": {
          "type": "string",
          "example": "target-entity-guid"
        },
        "typeName": {
          "type": "string",
          "example": "DataSet"
        }
      }
    }
  }
}