Apache Atlas · Schema

AtlasSearchResult

Result of a search query against the Atlas metadata repository.

ApacheBig DataComplianceData GovernanceData LineageHadoopMetadataOpen-Source

Properties

Name Type Description
queryType string Type of search query executed.
searchParameters object The search parameters that were used.
entities array List of matching entity headers.
approximateCount integer Approximate total count of matching entities.
View JSON Schema on GitHub

JSON Schema

atlas-atlas-search-result-schema.json Raw ↑ 
{
  "$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-search-result-schema.json",
  "title": "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
    }
  }
}