Atlas exposes a variety of REST endpoints to work with types, entities, lineage and data discovery.

Resources

There is a WADL document available that describes the resources API.

You may also enjoy the interactive interface provided for this API by Swagger.

Try it out!

name path methods description
DiscoveryREST
  • /v2/search/attribute
  • /v2/search/basic
  • /v2/search/dsl
  • /v2/search/fulltext
  • /v2/search/relationship
  • /v2/search/saved
  • /v2/search/saved/{guid}
  • /v2/search/saved/{name}
  • /v2/search/saved/execute/{name}
  • /v2/search/saved/execute/guid/{guid}
  • GET
  • GET POST
  • GET
  • GET
  • GET
  • GET POST PUT
  • DELETE
  • GET
  • GET
  • GET
REST interface for data discovery using dsl or full text search
EntityREST
  • /v2/entity
  • /v2/entity/bulk
  • /v2/entity/bulk/classification
  • /v2/entity/guid/{guid}
  • /v2/entity/guid/{guid}/classifications
  • /v2/entity/guid/{guid}/header
  • /v2/entity/uniqueAttribute/type/{typeName}
  • /v2/entity/guid/{guid}/classification/{classificationName}
  • /v2/entity/uniqueAttribute/type/{typeName}/classifications
  • /v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}
  • POST
  • DELETE GET POST
  • POST
  • DELETE GET PUT
  • GET POST PUT
  • GET
  • DELETE GET PUT
  • DELETE GET
  • POST PUT
  • DELETE
REST for a single entity
LineageREST
  • /v2/lineage/{guid}
  • GET
REST interface for an entity's lineage information
TypesREST
  • /v2/types/typedefs
  • /v2/types/typedefs/headers
  • /v2/types/classificationdef/guid/{guid}
  • /v2/types/classificationdef/name/{name}
  • /v2/types/entitydef/guid/{guid}
  • /v2/types/entitydef/name/{name}
  • /v2/types/enumdef/guid/{guid}
  • /v2/types/enumdef/name/{name}
  • /v2/types/structdef/guid/{guid}
  • /v2/types/structdef/name/{name}
  • /v2/types/typedef/guid/{guid}
  • /v2/types/typedef/name/{name}
  • /v2/types/typedef/name/{typeName}
  • DELETE GET POST PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • DELETE
REST interface for CRUD operations on type definitions

Data Types

JSON

type description
AtlasAttributeDef
AtlasBaseModelObject
AtlasBaseTypeDef
AtlasClassification
AtlasClassificationDef
AtlasClassifications
AtlasConstraintDef
AtlasEntitiesWithExtInfo
AtlasEntity
AtlasEntityDef
AtlasEntityExtInfo
AtlasEntityHeader
AtlasEntityWithExtInfo
AtlasEnumDef
AtlasEnumElementDef
AtlasFullTextResult
AtlasLineageInfo
AtlasQueryType
AtlasSearchResult
AtlasStruct
AtlasStructDef
AtlasTypeDefHeader
AtlasTypesDef
AtlasUserSavedSearch
AttributeSearchResult
Cardinality
ClassificationAssociateRequest
Condition
Currency
DateFormat
EntityMutationResponse
EntityOperation
FilterCriteria
Format
LineageDirection
LineageRelation
Locale
NumberFormat
Operator
PList
RoundingMode
SavedSearchType
SearchParameters
SortType
Status
TimeZone
TypeCategory

XML

Default Namespace (schema)
type description
atlasBaseModelObject
PList
searchFilter
sortType
atlasClassification
atlasStruct