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/quick
  • /v2/search/relations
  • /v2/search/relationship
  • /v2/search/saved
  • /v2/search/suggestions
  • /v2/search/download/status
  • /v2/search/download/{filename}
  • /v2/search/saved/{guid}
  • /v2/search/saved/{name}
  • /v2/search/basic/download/create_file
  • /v2/search/dsl/download/create_file
  • /v2/search/saved/execute/{name}
  • /v2/search/saved/execute/guid/{guid}
  • GET
  • GET POST
  • GET
  • GET
  • GET POST
  • GET POST
  • GET
  • GET POST PUT
  • GET
  • GET
  • GET
  • DELETE
  • GET
  • POST
  • POST
  • 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/bulk/headers
  • /v2/entity/bulk/setClassifications
  • /v2/entity/businessmetadata/import
  • /v2/entity/guid/{guid}
  • /v2/entity/{guid}/audit
  • /v2/entity/businessmetadata/import/template
  • /v2/entity/guid/{guid}/businessmetadata
  • /v2/entity/guid/{guid}/classifications
  • /v2/entity/guid/{guid}/header
  • /v2/entity/guid/{guid}/labels
  • /v2/entity/uniqueAttribute/type/{typeName}
  • /v2/entity/bulk/uniqueAttribute/type/{typeName}
  • /v2/entity/guid/{guid}/businessmetadata/{bmName}
  • /v2/entity/guid/{guid}/classification/{classificationName}
  • /v2/entity/uniqueAttribute/type/{typeName}/classifications
  • /v2/entity/uniqueAttribute/type/{typeName}/header
  • /v2/entity/uniqueAttribute/type/{typeName}/labels
  • /v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName}
  • POST
  • DELETE GET POST
  • POST
  • GET
  • POST
  • POST
  • DELETE GET PUT
  • GET
  • GET
  • DELETE POST
  • GET POST PUT
  • GET
  • DELETE POST PUT
  • DELETE GET PUT
  • GET
  • DELETE POST
  • DELETE GET
  • POST PUT
  • GET
  • DELETE POST PUT
  • DELETE
REST for a single entity
GlossaryREST
  • /v2/glossary
  • /v2/glossary/categories
  • /v2/glossary/category
  • /v2/glossary/import
  • /v2/glossary/term
  • /v2/glossary/terms
  • /v2/glossary/{glossaryGuid}
  • /v2/glossary/category/{categoryGuid}
  • /v2/glossary/import/template
  • /v2/glossary/term/{termGuid}
  • /v2/glossary/{glossaryGuid}/categories
  • /v2/glossary/{glossaryGuid}/detailed
  • /v2/glossary/{glossaryGuid}/partial
  • /v2/glossary/{glossaryGuid}/terms
  • /v2/glossary/category/{categoryGuid}/partial
  • /v2/glossary/category/{categoryGuid}/related
  • /v2/glossary/category/{categoryGuid}/terms
  • /v2/glossary/term/{termGuid}/partial
  • /v2/glossary/terms/{termGuid}/assignedEntities
  • /v2/glossary/terms/{termGuid}/related
  • /v2/glossary/{glossaryGuid}/categories/headers
  • /v2/glossary/{glossaryGuid}/terms/headers
  • GET POST
  • POST
  • POST
  • POST
  • POST
  • POST
  • DELETE GET PUT
  • DELETE GET PUT
  • GET
  • DELETE GET PUT
  • GET
  • GET
  • PUT
  • GET
  • PUT
  • GET
  • GET
  • PUT
  • DELETE GET POST PUT
  • GET
  • GET
  • GET
IndexRecoveryREST
  • /v2/indexrecovery
  • /v2/indexrecovery/start
  • GET
  • POST
LineageREST
  • /v2/lineage/{guid}
  • /v2/lineage/uniqueAttribute/type/{typeName}
  • GET POST
  • GET
REST interface for an entity's lineage information
NotificationREST
  • /v2/notification/topic/{topicName}
  • POST
RelationshipREST
  • /v2/relationship
  • /v2/relationship/guid/{guid}
  • POST PUT
  • DELETE GET
REST interface for entity relationships.
TypesREST
  • /v2/types/typedefs
  • /v2/types/typedefs/headers
  • /v2/types/businessmetadatadef/guid/{guid}
  • /v2/types/businessmetadatadef/name/{name}
  • /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/relationshipdef/guid/{guid}
  • /v2/types/relationshipdef/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
  • GET
  • GET
  • GET
  • GET
  • DELETE
REST interface for CRUD operations on type definitions

Data Types

JSON

type description
AtlasAggregationEntry
AtlasAttributeDef
AtlasBaseModelObject
AtlasBaseTypeDef
AtlasBusinessMetadataDef
AtlasClassification
AtlasClassificationDef
AtlasClassifications
AtlasConstraintDef
AtlasEntitiesWithExtInfo
AtlasEntity
AtlasEntityDef
AtlasEntityExtInfo
AtlasEntityHeader
AtlasEntityHeaders
AtlasEntityWithExtInfo
AtlasEnumDef
AtlasEnumElementDef
AtlasFullTextResult
AtlasGlossary
AtlasGlossaryBaseObject
AtlasGlossaryCategory
AtlasGlossaryExtInfo
AtlasGlossaryHeader
AtlasGlossaryTerm
AtlasGlossaryTermHeader
AtlasLineageInfo
AtlasObjectId
AtlasQueryType
AtlasQuickSearchResult
AtlasRelatedCategoryHeader
AtlasRelatedObjectId
AtlasRelatedTermHeader
AtlasRelationship
AtlasRelationshipAttributeDef
AtlasRelationshipDef
AtlasRelationshipEndDef
AtlasRelationshipHeader
AtlasRelationshipWithExtInfo
AtlasSearchDownloadRecord
AtlasSearchResult
AtlasSearchResultDownloadStatus
AtlasStruct
AtlasStructDef
AtlasSuggestionsResult
AtlasTermAssignmentHeader
AtlasTermAssignmentStatus
AtlasTermCategorizationHeader
AtlasTermRelationshipStatus
AtlasTypeDefHeader
AtlasTypesDef
AtlasUserSavedSearch
AttributeSearchResult
BulkImportResponse
Cardinality
ClassificationAssociateRequest
Condition
DateFormat
EntityAuditActionV2
EntityAuditEventV2
EntityAuditType
EntityMutationResponse
EntityOperation
FilterCriteria
Format
ImportInfo
ImportStatus
IndexType
LineageDirection
LineageInfoOnDemand
LineageOnDemandConstraints
LineageRelation
NumberFormat
Operator
PList
PropagateTags
QuickSearchParameters
Relation
RelationshipCategory
RelationshipSearchParameters
RoundingMode
SavedSearchType
SearchFilter
SearchParameters
SortOrder
SortType
Status
Status
Status
TimeBoundary
TimeZone
TypeCategory

XML

Default Namespace (schema)
type description
PList
searchFilter
sortType
timeBoundary