Apache Atlas · JSON Structure

Atlas Atlas Search Result Structure

Result of a search query against the Atlas metadata repository.

Type: object Properties: 4
ApacheBig DataComplianceData GovernanceData LineageHadoopMetadataOpen Source

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

Properties

queryType searchParameters entities approximateCount

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-search-result-structure.json",
  "name": "AtlasSearchResult",
  "description": "Result of a search query against the Atlas metadata repository.",
  "type": "object",
  "properties": {
    "queryType": {
      "type": "string",
      "description": "Type of search query executed.",
      "example": "BASIC"
    },
    "searchParameters": {
      "type": "object",
      "description": "The search parameters that were used."
    },
    "entities": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "description": "List of matching entity headers."
    },
    "approximateCount": {
      "type": "integer",
      "description": "Approximate total count of matching entities.",
      "example": 42
    }
  }
}