Atlan logo

  • API Changelog

Download source
  • JSON OpenAPI specification
  • YAML OpenAPI specification
Help

Topics

  • Introduction
  • SDKs
  • Important notes
  • Terminology
  • Authentication
  • Postman

Endpoints

  • Search
    • POST
      Find asset by exact name
    • POST
      Find classified assets
    • POST
      Find assets by type
    • POST
      Find child assets by parent qualifiedName
  • All assets
    • GET
      Get asset by GUID
    • DELETE
      Delete asset by GUID
    • GET
      Get asset by qualified name
    • POST
      Get asset history
    • POST
      Attach custom metadata
    • POST
      Attach classification
    • POST
      Attach glossary terms
    • POST
      Add a readme
    • POST
      Change description
    • POST
      Change certificate
    • POST
      Change announcement
    • POST
      Change owners
    • DELETE
      Delete assets in bulk
  • Data assets
    • POST
      Create connections
    • POST
      Restore connections
    • POST
      Create databases
    • POST
      Restore databases
    • POST
      Create schemas
    • POST
      Restore schemas
    • POST
      Create tables
    • POST
      Restore tables
    • POST
      Create columns
    • POST
      Restore columns
  • S3 assets
    • POST
      Create S3 connections
    • POST
      Restore S3 connections
    • POST
      Create S3 buckets
    • POST
      Restore S3 buckets
    • POST
      Create S3 objects
    • POST
      Restore S3 objects
  • Data Studio assets
    • POST
      Create Data Studio connections
    • POST
      Restore Data Studio connections
    • POST
      Create Data Studio assets
    • POST
      Restore Data Studio assets
  • Lineage
    • POST
      Create processes
    • POST
      Create column processes
    • POST
      Get lineage
  • Custom metadata
    • GET
      List custom metadata definitions
    • PUT
      Update custom metadata definitions
    • POST
      Create custom metadata definitions
  • Classifications
    • GET
      List classification definitions
    • PUT
      Update classification definitions
    • POST
      Create classifications
  • Personas
    • GET
      List personas
    • POST
      Create persona
    • GET
      Get persona
    • POST
      Update persona
    • DELETE
      Delete persona
    • POST
      Toggle persona
    • POST
      Add subjects to personas
    • POST
      Add metadata policy
    • POST
      Add data policy
    • POST
      Add glossary policy
  • Purposes
    • GET
      List purposes
    • POST
      Create purpose
    • GET
      Get purpose
    • POST
      Update purpose
    • DELETE
      Delete purpose
    • POST
      Toggle purpose
  • Workflow
    • POST
      Run workflow
    • GET
      Get workflow run
    • POST
      Find workflows
  • Glossary
    • POST
      Create glossaries
    • POST
      Restore glossaries
    • POST
      Create categories
    • POST
      Restore categories
    • POST
      Create terms
    • POST
      Restore terms
  • Admin
    • GET
      List users
    • POST
      Invite users
    • POST
      Toggle user
    • GET
      List roles
    • POST
      Update user role
    • GET
      List groups
    • POST
      Create groups
    • POST
      Add user to groups
    • GET
      Get current user
    • POST
      Delete user session
    • GET
      Get user sessions
    • POST
      Delete all sessions of a user
  • Canonical
    • POST
      Upsert entities
Powered by Bump.sh

Search

Operations for finding assets.

Atlan uses Elastic's Query DSL to provide an extremely powerful and flexible search capability. With that flexibility comes some complexity. We have a detailed write-up of search in our Developer Portal.

Provided below are a few common examples of the search patterns.