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}/audit
  • /v2/entity/guid/{guid}/classifications
  • /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
  • GET POST PUT
  • DELETE GET PUT
  • DELETE GET
  • POST PUT
  • DELETE
REST for a single entity
GlossaryREST
  • /v2/glossary
  • /v2/glossary/categories
  • /v2/glossary/category
  • /v2/glossary/term
  • /v2/glossary/terms
  • /v2/glossary/{glossaryGuid}
  • /v2/glossary/category/{categoryGuid}
  • /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
  • DELETE GET PUT
  • DELETE GET PUT
  • DELETE GET PUT
  • GET
  • GET
  • PUT
  • GET
  • PUT
  • GET
  • GET
  • PUT
  • DELETE GET POST
  • GET
  • GET
  • GET
LineageREST
  • /v2/lineage/{guid}
  • GET
REST interface for an entity's lineage information
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/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}
  • DELETE GET POST PUT
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
  • GET
REST interface for CRUD operations on type definitions

Data Types

JSON

type description
AtlasClassification An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
AtlasStruct Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.
ClassificationAssociateRequest
PList Paginated-list, for returning search results.
SearchFilter Generic filter, to specify search criteria using name/value pairs.
SortType to specify whether the result should be sorted? If yes, whether asc or desc.
TimeBoundary Captures time-boundary details

XML

Default Namespace (schema)
type description
PList Paginated-list, for returning search results.
searchFilter Generic filter, to specify search criteria using name/value pairs.
sortType to specify whether the result should be sorted? If yes, whether asc or desc.
timeBoundary Captures time-boundary details
atlasClassification An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
atlasStruct Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.