-
Notifications
You must be signed in to change notification settings - Fork 97
Atlas and Purview API Coverage
Will Johnson edited this page Jan 10, 2021
·
5 revisions
The below table shows which API endpoints are implemented in the PyApacheAtlas package. Where it references AtlasClient, it is also implemented for the PurviewClient as well.
| Name | Path | Method | Pyapacheatlas Support |
|---|---|---|---|
| DiscoveryREST | All | Any | ❌ |
| EntityREST | /v2/entity | POST | ✔️ AtlasClient.upload_entities |
| EntityREST | /v2/entity/bulk | DELETE | ✔️ AtlasClient.delete_entity |
| EntityREST | /v2/entity/bulk | GET | ✔️ AtlasClient.get_entity |
| EntityREST | /v2/entity/bulk | POST | ✔️ AtlasClient.upload_entities |
| EntityREST | /v2/entity/bulk/classification | POST | ✔️ AtlasClient.classify_bulk_entities |
| EntityREST | /v2/entity/bulk/headers | GET | ❌ |
| EntityREST | /v2/entity/bulk/setClassifications | POST | ❌ |
| EntityREST | /v2/entity/businessmetadata/import | POST | ❌ |
| EntityREST | /v2/entity/guid/{guid} | DELETE | ✔️ AtlasClient.delete_entity |
| EntityREST | /v2/entity/guid/{guid} | GET | ✔️ AtlasClient.get_entity |
| EntityREST | /v2/entity/guid/{guid} | PUT | ✔️ AtlasClient.upload_entities |
| EntityREST | /v2/entity/{guid}/audit | GET | ❌ |
| EntityREST | /v2/entity/businessmetadata/import/template | GET | ❌ |
| EntityREST | /v2/entity/guid/{guid}/businessmetadata | DELETE | ❌ |
| EntityREST | /v2/entity/guid/{guid}/businessmetadata | POST | ❌ |
| EntityREST | /v2/entity/guid/{guid}/classifications | GET | ✔️ AtlasClient.get_entity_classifications |
| EntityREST | /v2/entity/guid/{guid}/classifications | POST | ✔️ AtlasClient.classify_entity |
| EntityREST | /v2/entity/guid/{guid}/classifications | PUT | ✔️ AtlasClient.classify_entity |
| EntityREST | /v2/entity/guid/{guid}/header | GET | ✔️ AtlasClient.get_entity_header |
| EntityREST | /v2/entity/guid/{guid}/labels | DELETE | ❌ |
| EntityREST | /v2/entity/guid/{guid}/labels | POST | ❌ |
| EntityREST | /v2/entity/guid/{guid}/labels | PUT | ❌ |
| EntityREST | /v2/entity/uniqueAttribute/type/{typeName} | DELETE | ❌ |
| EntityREST | /v2/entity/uniqueAttribute/type/{typeName} | POST | ❌ |
| EntityREST | /v2/entity/uniqueAttribute/type/{typeName} | PUT | ❌ |
| EntityREST | /v2/entity/bulk/uniqueAttribute/type/{typeName} | DELETE | ❌ |
| EntityREST | /v2/entity/bulk/uniqueAttribute/type/{typeName} | GET | ✅ Privately used in AtlasClient.get_entity |
| EntityREST | /v2/entity/bulk/uniqueAttribute/type/{typeName} | PUT | ❌ |
| EntityREST | /v2/entity/guid/{guid}/businessmetadata/{bmName} | GET | ❌ |
| EntityREST | /v2/entity/guid/{guid}/classification/{classificationName} | DELETE | ✔️ AtlasClient.declassify_entity |
| EntityREST | /v2/entity/guid/{guid}/classification/{classificationName} | GET | ✔️ AtlasClient.get_entity_classifications |
| EntityREST | /v2/entity/uniqueAttribute/type/{typeName}/classifications | POST | ❌ |
| EntityREST | /v2/entity/uniqueAttribute/type/{typeName}/classifications | PUT | ❌ |
| EntityREST | /v2/entity/uniqueAttribute/type/{typeName}/header | GET | ❌ |
| EntityREST | /v2/entity/uniqueAttribute/type/{typeName}/labels | DELETE | ❌ |
| EntityREST | /v2/entity/uniqueAttribute/type/{typeName}/labels | POST | ❌ |
| EntityREST | /v2/entity/uniqueAttribute/type/{typeName}/labels | PUT | ❌ |
| EntityREST | /v2/entity/uniqueAttribute/type/{typeName}/classification/{classificationName} | DELETE | ❌ |
| GlossaryREST | /v2/glossary | GET | ✔️ AtlasClient.get_glossary |
| GlossaryREST | /v2/glossary | POST | ❌ |
| GlossaryREST | /v2/glossary/categories | POST | ❌ |
| GlossaryREST | /v2/glossary/category | POST | ❌ |
| GlossaryREST | /v2/glossary/import | POST | ❌ |
| GlossaryREST | /v2/glossary/term | POST | ✔️ AtlasClient.upload_terms |
| GlossaryREST | /v2/glossary/terms | POST | ✔️ AtlasClient.upload_terms |
| GlossaryREST | /v2/glossary/{glossaryGuid} | DELETE | ❌ |
| GlossaryREST | /v2/glossary/{glossaryGuid} | GET | ✔️ AtlasClient.get_glossary |
| GlossaryREST | /v2/glossary/{glossaryGuid} | PUT | ❌ |
| GlossaryREST | /v2/glossary/category/{categoryGuid} | DELETE | ❌ |
| GlossaryREST | /v2/glossary/category/{categoryGuid} | GET | ❌ |
| GlossaryREST | /v2/glossary/category/{categoryGuid} | PUT | ❌ |
| GlossaryREST | /v2/glossary/import/template | GET | ❌ |
| GlossaryREST | /v2/glossary/term/{termGuid} | DELETE | ❌ |
| GlossaryREST | /v2/glossary/term/{termGuid} | GET | ✔️ AtlasClient.get_glossary_term |
| GlossaryREST | /v2/glossary/term/{termGuid} | PUT | ❌ |
| GlossaryREST | /v2/glossary/{glossaryGuid}/categories | GET | ❌ |
| GlossaryREST | /v2/glossary/{glossaryGuid}/detailed | GET | ✔️ AtlasClient.get_glossary |
| GlossaryREST | /v2/glossary/{glossaryGuid}/partial | PUT | ❌ |
| GlossaryREST | /v2/glossary/{glossaryGuid}/terms | GET | ❌ |
| GlossaryREST | /v2/glossary/category/{categoryGuid}/partial | PUT | ❌ |
| GlossaryREST | /v2/glossary/category/{categoryGuid}/related | GET | ❌ |
| GlossaryREST | /v2/glossary/category/{categoryGuid}/terms | GET | ❌ |
| GlossaryREST | /v2/glossary/term/{termGuid}/partial | PUT | ❌ |
| GlossaryREST | /v2/glossary/terms/{termGuid}/assignedEntities | DELETE | ❌ |
| GlossaryREST | /v2/glossary/terms/{termGuid}/assignedEntities | GET | ❌ |
| GlossaryREST | /v2/glossary/terms/{termGuid}/assignedEntities | POST | ❌ |
| GlossaryREST | /v2/glossary/terms/{termGuid}/assignedEntities | PUT | ❌ |
| GlossaryREST | /v2/glossary/terms/{termGuid}/related | GET | ❌ |
| GlossaryREST | /v2/glossary/{glossaryGuid}/categories/headers | GET | ❌ |
| GlossaryREST | /v2/glossary/{glossaryGuid}/terms/headers | GET | ❌ |
| LineageREST | /v2/lineage/{guid} | GET | ❌ |
| LineageREST | /v2/lineage/uniqueAttribute/type/{typeName} | GET | ❌ |
| RelationshipREST | /v2/relationship | POST | ✔️ AtlasClient.upload_relationship |
| RelationshipREST | /v2/relationship | PUT | ❌ |
| RelationshipREST | /v2/relationship/guid/{guid} | DELETE | ❌ |
| RelationshipREST | /v2/relationship/guid/{guid} | GET | ✔️ AtlasClient.get_relationship |
| TypesREST | /v2/types/typedefs | DELETE | ❌ |
| TypesREST | /v2/types/typedefs | GET | ✔️ AtlasClient.get_all_typedefs |
| TypesREST | /v2/types/typedefs | POST | ✔️ AtlasClient.upload_typedefs |
| TypesREST | /v2/types/typedefs | PUT | ✔️ AtlasClient.upload_typedefs |
| TypesREST | /v2/types/typedefs/headers | GET | ✔️ AtlasClient._get_typedefs_header |
| TypesREST | /v2/types/businessmetadatadef/guid/{guid} | GET | ❌ |
| TypesREST | /v2/types/businessmetadatadef/name/{name} | GET | ❌ |
| TypesREST | /v2/types/classificationdef/guid/{guid} | GET | ✔️ AtlasClient.get_typedef(TypeCategory.CLASSIFICATION, guid=) |
| TypesREST | /v2/types/classificationdef/name/{name} | GET | ✔️ AtlasClient.get_typedef(TypeCategory.CLASSIFICATION, guid=) |
| TypesREST | /v2/types/entitydef/guid/{guid} | GET | ✔️ AtlasClient.get_typedef(TypeCategory.ENTITY, guid=) |
| TypesREST | /v2/types/entitydef/name/{name} | GET | ✔️ AtlasClient.get_typedef(TypeCategory.ENTITY, name=) |
| TypesREST | /v2/types/enumdef/guid/{guid} | GET | ✔️ AtlasClient.get_typedef(TypeCategory.ENUM, guid=) |
| TypesREST | /v2/types/enumdef/name/{name} | GET | ✔️ AtlasClient.get_typedef(TypeCategory.ENUM, name=) |
| TypesREST | /v2/types/relationshipdef/guid/{guid} | GET | ✔️ AtlasClient.get_typedef(TypeCategory.RELATIONSHIP, guid=) |
| TypesREST | /v2/types/relationshipdef/name/{name} | GET | ✔️ AtlasClient.get_typedef(TypeCategory.RELATIONSHIP, name=) |
| TypesREST | /v2/types/structdef/guid/{guid} | GET | ✔️ AtlasClient.get_typedef(TypeCategory.STRUCT, guid=) |
| TypesREST | /v2/types/structdef/name/{name} | GET | ✔️ AtlasClient.get_typedef(TypeCategory.STRUCT, name=) |
| TypesREST | /v2/types/typedef/guid/{guid} | GET | ✔️ AtlasClient.get_typedef |
| TypesREST | /v2/types/typedef/name/{name} | GET | ✔️ AtlasClient.get_typedef |
| TypesREST | /v2/types/typedef/name/{typeName} | DELETE | ✔️ AtlasClient.delete_type |