Azure Purview: Purviewdatamap
Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Purview Data Map Service is a fully managed cloud service whose users can
discover the data sources they need and understand the data sources they find.
At the same time, Data Map helps organizations get more value from their
existing investments. This spec defines REST API of Purview Data Map Service.
Endpoints 96
- POSTEntity_CreateOrUpdate
/atlas/v2/entity?api-version=string&businessAttributeUpdateBehavior=ignore&collectionId=stringCreate or update an entity. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array of… - GETEntity_ListByGuids
/atlas/v2/entity/bulk?api-version=string&guid=string&minExtInfo=true&ignoreRelationships=trueList entities in bulk identified by its GUIDs. - POSTEntity_BulkCreateOrUpdate
/atlas/v2/entity/bulk?api-version=string&collectionId=string&businessAttributeUpdateBehavior=ignoreCreate or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its unique attributes eg: qualifiedName. Map and array… - DELETEEntity_BulkDelete
/atlas/v2/entity/bulk?guid=stringDelete a list of entities in bulk identified by their GUIDs or unique attributes. - POSTEntity_AddClassification
/atlas/v2/entity/bulk/classificationAssociate a classification to multiple entities in bulk. - POSTEntity_BulkSetClassifications
/atlas/v2/entity/bulk/setClassificationsSet classifications on entities in bulk. - GETEntity_ListByUniqueAttributes
/atlas/v2/entity/bulk/uniqueAttribute/type/:typeName?minExtInfo=true&ignoreRelationships=true&attr_N:qualifiedName=stringBulk API to retrieve list of entities identified by its unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be… - POSTEntity_ImportBusinessMetadata
/atlas/v2/entity/businessmetadata/importUpload the file for creating Business Metadata in BULK - GETEntity_GetSampleBusinessMetadataTemplate
/atlas/v2/entity/businessmetadata/import/templateGet the sample Template for uploading/creating bulk BusinessMetaData - GETEntity_Get
/atlas/v2/entity/guid/:guid?minExtInfo=true&ignoreRelationships=trueGet complete definition of an entity given its GUID. - PUTEntity_PartialUpdateAttributeByGuid
/atlas/v2/entity/guid/:guid?name=stringUpdate entity partially - create or update entity attribute identified by its GUID. Supports only primitive attribute type and entity references. It does not… - DELETEEntity_Delete
/atlas/v2/entity/guid/:guidDelete an entity identified by its GUID. - POSTEntity_AddOrUpdateBusinessMetadata
/atlas/v2/entity/guid/:guid/businessmetadata?isOverwrite=trueAdd business metadata to an entity. - DELETEEntity_RemoveBusinessMetadata
/atlas/v2/entity/guid/:guid/businessmetadataRemove business metadata from an entity. - POSTEntity_AddOrUpdateBusinessMetadataAttributes
/atlas/v2/entity/guid/:guid/businessmetadata/:businessMetadataNameAdd or update business metadata attributes. - DELETEEntity_RemoveBusinessMetadataAttributes
/atlas/v2/entity/guid/:guid/businessmetadata/:businessMetadataNameDelete business metadata attributes from an entity. - GETEntity_GetClassification
/atlas/v2/entity/guid/:guid/classification/:classificationNameGet classification for a given entity represented by a GUID. - DELETEEntity_RemoveClassification
/atlas/v2/entity/guid/:guid/classification/:classificationName?suppressDeletedClassification=trueDelete a given classification from an existing entity represented by a GUID. - GETEntity_GetClassifications
/atlas/v2/entity/guid/:guid/classificationsList classifications for a given entity represented by a GUID. - PUTEntity_UpdateClassifications
/atlas/v2/entity/guid/:guid/classificationsUpdate classifications to an existing entity represented by a guid. - POSTEntity_AddClassifications
/atlas/v2/entity/guid/:guid/classificationsAdd classifications to an existing entity represented by a GUID. - GETEntity_GetHeader
/atlas/v2/entity/guid/:guid/headerGet entity header given its GUID. - PUTEntity_AddLabel
/atlas/v2/entity/guid/:guid/labelsAdd given labels to a given entity. - POSTEntity_SetLabels
/atlas/v2/entity/guid/:guid/labelsSet labels to a given entity. - DELETEEntity_RemoveLabels
/atlas/v2/entity/guid/:guid/labelsDelete given labels to a given entity. - GETEntity_GetByUniqueAttributes
/atlas/v2/entity/uniqueAttribute/type/:typeName?minExtInfo=true&ignoreRelationships=true&attr:qualifiedName=stringGet complete definition of an entity given its type and unique attribute. In addition to the typeName path parameter, attribute key-value pair(s) can be… - PUTEntity_PartialUpdateByUniqueAttributes
/atlas/v2/entity/uniqueAttribute/type/:typeName?attr:qualifiedName=stringUpdate entity partially - Allow a subset of attributes to be updated on an entity which is identified by its type and unique attribute eg:… - DELETEEntity_DeleteByUniqueAttribute
/atlas/v2/entity/uniqueAttribute/type/:typeName?attr:qualifiedName=stringDelete an entity identified by its type and unique attributes. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the… - DELETEEntity_RemoveClassificationByUniqueAttribute
/atlas/v2/entity/uniqueAttribute/type/:typeName/classification/:classificationName?attr:qualifiedName=stringDelete a given classification from an entity identified by its type and unique attributes. - PUTEntity_UpdateClassificationsByUniqueAttribute
/atlas/v2/entity/uniqueAttribute/type/:typeName/classifications?attr:qualifiedName=stringUpdate classification on an entity identified by its type and unique attributes. - POSTEntity_AddClassificationsByUniqueAttribute
/atlas/v2/entity/uniqueAttribute/type/:typeName/classifications?attr:qualifiedName=stringAdd classification to the entity identified by its type and unique attributes. - PUTEntity_AddLabelsByUniqueAttribute
/atlas/v2/entity/uniqueAttribute/type/:typeName/labels?attr:qualifiedName=stringAdd given labels to a given entity identified by its type and unique attributes. If labels is null/empty, no labels will be added. In addition to the typeName… - POSTEntity_SetLabelsByUniqueAttribute
/atlas/v2/entity/uniqueAttribute/type/:typeName/labels?attr:qualifiedName=stringSet labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing labels will all be removed. In addition to the… - DELETEEntity_RemoveLabelsByUniqueAttribute
/atlas/v2/entity/uniqueAttribute/type/:typeName/labels?attr:qualifiedName=stringDelete given labels to a given entity identified by its type and unique attribute. If labels is null/empty, no labels will be removed. If any labels in labels… - GETGlossary_List
/atlas/v2/glossary?api-version=string&limit=0&offset=0&sort=string&ignoreTermsAndCategories=trueGet all glossaries. Recommend using limit/offset to get pagination result. Recommend using 'ignoreTermsAndCategories=true' and fetch terms/categories… - POSTGlossary_Create
/atlas/v2/glossaryCreate a glossary. - GETGlossary_Get
/atlas/v2/glossary/:glossaryIdGet a specific Glossary by its GUID. - PUTGlossary_Update
/atlas/v2/glossary/:glossaryId?api-version=string&ignoreTermsAndCategories=trueUpdate the given glossary. - DELETEGlossary_Delete
/atlas/v2/glossary/:glossaryIdDelete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and categories. - GETGlossary_ListCategories
/atlas/v2/glossary/:glossaryId/categories?limit=0&offset=0&sort=stringGet the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result. - GETGlossary_ListCategoriesHeaders
/atlas/v2/glossary/:glossaryId/categories/headers?limit=0&offset=0&sort=stringGet the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination result. - GETGlossary_GetDetailed
/atlas/v2/glossary/:glossaryId/detailed?api-version=stringGet a specific glossary with detailed information. This API is not recommend. Recommend to fetch terms/categories details separately using GET… - PUTGlossary_PartialUpdate
/atlas/v2/glossary/:glossaryId/partial?api-version=string&ignoreTermsAndCategories=trueUpdate the glossary partially. Some properties such as qualifiedName are not allowed to be updated. So far we only supports partial updating shortDescription,… - GETGlossary_ListTerms
/atlas/v2/glossary/:glossaryId/terms?api-version=string&limit=0&offset=0&sort=stringGet terms belonging to a specific glossary. Recommend using limit/offset to get pagination result. - GETGlossary_ListTermHeaders
/atlas/v2/glossary/:glossaryId/terms/headers?limit=0&offset=0&sort=stringGet term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result. - POSTGlossary_CreateCategories
/atlas/v2/glossary/categoriesCreate glossary category in bulk. - POSTGlossary_CreateCategory
/atlas/v2/glossary/categoryCreate a glossary category. - GETGlossary_GetCategory
/atlas/v2/glossary/category/:categoryIdGet specific glossary category by its GUID. - PUTGlossary_UpdateCategory
/atlas/v2/glossary/category/:categoryIdUpdate the given glossary category by its GUID. - DELETEGlossary_DeleteCategory
/atlas/v2/glossary/category/:categoryIdDelete a glossary category. - PUTGlossary_PartialUpdateCategory
/atlas/v2/glossary/category/:categoryId/partialUpdate the glossary category partially. So far we only supports partial updating shortDescription and longDescription for category. - GETGlossary_ListRelatedCategories
/atlas/v2/glossary/category/:categoryId/related?limit=0&offset=0&sort=stringGet all related categories (parent and children). Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed. - GETGlossary_ListCategoryTerms
/atlas/v2/glossary/category/:categoryId/terms?limit=0&offset=0&sort=stringGet all terms associated with the specific category. - POSTGlossary_CreateTerm
/atlas/v2/glossary/term?includeTermHierarchy=trueCreate a glossary term. - GETGlossary_GetTerm
/atlas/v2/glossary/term/:termId?api-version=stringGet a specific glossary term by its GUID. - PUTGlossary_UpdateTerm
/atlas/v2/glossary/term/:termId?api-version=string&includeTermHierarchy=trueUpdate the given glossary term by its GUID. - DELETEGlossary_DeleteTerm
/atlas/v2/glossary/term/:termIdDelete a glossary term. - PUTGlossary_PartialUpdateTerm
/atlas/v2/glossary/term/:termId/partial?api-version=string&includeTermHierarchy=trueUpdate the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term. - POSTGlossary_CreateTerms
/atlas/v2/glossary/terms?api-version=string&includeTermHierarchy=trueCreate glossary terms in bulk. - GETGlossary_ListEntitiesAssignedWithTerm
/atlas/v2/glossary/terms/:termId/assignedEntities?limit=0&offset=0&sort=stringList all related objects assigned with the specified term. Recommend using limit/offset to get pagination result. - POSTGlossary_AssignTermToEntities
/atlas/v2/glossary/terms/:termId/assignedEntitiesAssign the given term to the provided list of related objects. Recommend using small batches with multiple API calls. Entities Create Or Update operation is… - DELETEGlossary_DeleteTermAssignmentFromEntities
/atlas/v2/glossary/terms/:termId/assignedEntitiesDelete the term assignment for the given list of related objects. - GETGlossary_ListRelatedTerms
/atlas/v2/glossary/terms/:termId/related?api-version=string&limit=0&offset=0&sort=stringGet all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not being enabled and won't work even they are passed. - GETLineage_Get
/atlas/v2/lineage/:guid?depth=0&direction=INPUTGet lineage info of the entity specified by GUID. - GETLineage_GetByUniqueAttribute
/atlas/v2/lineage/uniqueAttribute/type/:typeName?depth=0&direction=INPUT&attr:qualifiedName=stringReturn lineage info about entity. In addition to the typeName path parameter, attribute key-value pair(s) can be provided in the following format… - PUTRelationship_Update
/atlas/v2/relationshipUpdate an existing relationship between entities. - POSTRelationship_Create
/atlas/v2/relationshipCreate a new relationship between entities. - GETRelationship_Get
/atlas/v2/relationship/guid/:guid?extendedInfo=trueGet relationship information between entities by its GUID. - DELETERelationship_Delete
/atlas/v2/relationship/guid/:guidDelete a relationship between entities by its GUID. - GETType_GetBusinessMetadataDefByGuid
/atlas/v2/types/businessmetadatadef/guid/:guidGet the businessMetadata definition for the given guid. - GETType_GetBusinessMetadataDefByName
/atlas/v2/types/businessmetadatadef/name/:nameGet the businessMetadata definition by it's name (unique). - GETType_GetClassificationDefByGuid
/atlas/v2/types/classificationdef/guid/:guidGet the classification definition for the given GUID. - GETType_GetClassificationDefByName
/atlas/v2/types/classificationdef/name/:nameGet the classification definition by its name (unique). - GETType_GetEntityDefByGuid
/atlas/v2/types/entitydef/guid/:guidGet the Entity definition for the given GUID. - GETType_GetEntityDefByName
/atlas/v2/types/entitydef/name/:nameGet the entity definition by its name (unique). - GETType_GetEnumDefByGuid
/atlas/v2/types/enumdef/guid/:guidGet the enum definition for the given GUID. - GETType_GetEnumDefByName
/atlas/v2/types/enumdef/name/:nameGet the enum definition by its name (unique). - GETType_GetRelationshipDefByGuid
/atlas/v2/types/relationshipdef/guid/:guidGet the relationship definition for the given GUID. - GETType_GetRelationshipDefByName
/atlas/v2/types/relationshipdef/name/:nameGet the relationship definition by its name (unique). - GETType_GetStructDefByGuid
/atlas/v2/types/structdef/guid/:guidGet the struct definition for the given GUID. - GETType_GetStructDefByName
/atlas/v2/types/structdef/name/:nameGet the struct definition by its name (unique). - GETType_GetByGuid
/atlas/v2/types/typedef/guid/:guidGet the type definition for the given GUID. - GETType_GetByName
/atlas/v2/types/typedef/name/:nameGet the type definition by its name (unique). - DELETEType_Delete
/atlas/v2/types/typedef/name/:nameDelete API for type identified by its name. - GETType_List
/atlas/v2/types/typedefs?api-version=string&includeTermTemplate=true&type=PRIMITIVEList all type definitions in bulk. - PUTType_BulkUpdate
/atlas/v2/types/typedefsUpdate all types in bulk, changes detected in the type definitions would be persisted. - POSTType_BulkCreate
/atlas/v2/types/typedefsCreate all atlas type definitions in bulk. Please avoid recreating existing types. - DELETEType_BulkDelete
/atlas/v2/types/typedefsDelete API for all types in bulk. - GETType_ListHeaders
/atlas/v2/types/typedefs/headers?api-version=string&includeTermTemplate=true&type=PRIMITIVEList all type definitions returned as a list of minimal information header. - POSTEntity_MoveEntitiesToCollection
/entity/moveTo?api-version=string&collectionId=stringMove existing entities to the target collection. - GETLineage_GetNextPage
/lineage/:guid/next?api-version=string&direction=INPUT&offset=0&limit=0Return immediate next page lineage info about entity with pagination - POSTDiscovery_AutoComplete
/search/autocomplete?api-version=stringGet auto complete options. - POSTDiscovery_Query
/search/query?api-version=stringGet data using search. - POSTDiscovery_Suggest
/search/suggest?api-version=stringGet search suggestions by query criteria. - GETType_GetTermTemplateDefByGuid
/types/termtemplatedef/guid/:guid?api-version=stringGet the term template definition for the given GUID. - GETType_GetTermTemplateDefByName
/types/termtemplatedef/name/:name?api-version=stringGet the term template definition by its name (unique).
API details
- Authentication
- OAuth 2.0 (implicit flow) with 1 scope
- Operations
- 96 operations on 65 pathsGET 43POST 23DELETE 16PUT 14
- Response formats
application/json- Description format
- Swagger 2.0, API version
2023-09-01 - Links
- OpenAPI document
How to test the Azure Purview: Purviewdatamap in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Azure Purview: Purviewdatamap collection, without the publisher's secrets.
- Add your credentialsThis API uses OAuth 2.0 (implicit flow) with 1 scope. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Entity_CreateOrUpdate” (POST /atlas/v2/entity?api-version=string&businessAttributeUpdateBehavior=ignore&collectionId=string), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Azure Purview: Purviewdatamap?
Purview Data Map Service is a fully managed cloud service whose users can discover the data sources they need and understand the data sources they find. At… It is listed under Developer tools and has 96 endpoints.
Who publishes the Azure Purview: Purviewdatamap?
It is listed from Microsoft Azure's public API description (an OpenAPI document), not published by Microsoft Azure on Swastik Codes. Anyone who controls azure.com can claim the profile by adding a DNS TXT record.
How do I authenticate with the Azure Purview: Purviewdatamap?
With OAuth 2.0 (implicit flow) with 1 scope.
How many endpoints does the Azure Purview: Purviewdatamap have?
96 operations on 65 paths (43 GET, 23 POST, 16 DELETE, 14 PUT).
Is forking the Azure Purview: Purviewdatamap free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.