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 class that captures details of a struct-attribute.
AtlasBaseModelObject
AtlasBaseTypeDef Base class that captures common-attributes for all Atlas types.
AtlasClassification An instance of a classification; it doesn't have an identity, this object exists only when associated with an entity.
AtlasClassificationDef class that captures details of a classification-type.
AtlasClassifications REST serialization friendly list.
AtlasConstraintDef class that captures details of a constraint.
AtlasEntitiesWithExtInfo An instance of an entity along with extended info - like hive_table, hive_database.
AtlasEntity An instance of an entity - like hive_table, hive_database.
AtlasEntityDef class that captures details of a entity-type.
AtlasEntityExtInfo An instance of an entity along with extended info - like hive_table, hive_database.
AtlasEntityHeader An instance of an entity - like hive_table, hive_database.
AtlasEntityWithExtInfo An instance of an entity along with extended info - like hive_table, hive_database.
AtlasEnumDef class that captures details of an enum-type.
AtlasEnumElementDef class that captures details of an enum-element.
AtlasFullTextResult
AtlasLineageInfo
AtlasQueryType
AtlasSearchResult
AtlasStruct Captures details of struct contents. Not instantiated directly, used only via AtlasEntity, AtlasClassification.
AtlasStructDef class that captures details of a struct-type.
AtlasTypeDefHeader
AtlasTypesDef
AtlasUserSavedSearch
AttributeSearchResult
Cardinality single-valued attribute or multi-valued attribute.
ClassificationAssociateRequest
Condition
Currency
DateFormat
EntityMutationResponse
EntityOperation
FilterCriteria
Format
LineageDirection
LineageRelation
Locale
NumberFormat
Operator Supported search operations Logical comparision operators can only be used with numbers or dates IN, LIKE, startsWith, endsWith, CONTAINS can only be used with strings or text
PList Paginated-list, for returning search results.
RoundingMode
SavedSearchType
SearchParameters
SortType to specify whether the result should be sorted? If yes, whether asc or desc.
Status Status of the entity - can be active or deleted. Deleted entities are not removed from Atlas store.
TimeZone
TypeCategory

XML

Default Namespace (schema)
type description
atlasBaseModelObject
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.
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.