# Azure Analytics Purview Data Map API

> Azure Analytics Purview Data Map API on Apizie: 96 endpoints (Create or update an entity. Existing entity is matched using its unique guid if supplied or by its unique…, List entities in bulk identified by its GUIDs., Create or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its…, Delete a list of entities in bulk identified by their GUIDs or unique attributes., …) returned as clean JSON through one API key. Send your own provider key in the x-upstream-key header. Call it over REST at https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/{endpoint} or from Claude, ChatGPT and Cursor through the Apizie MCP server. Free plan: 1,000 requests a month.

- Project key: `cloud:azure-purview-datamap`
- Category: Cloud
- Status: byok
- Source: https://learn.microsoft.com/rest/api/azure/
- Page: https://zieapi.vercel.app/api/cloud/azure-purview-datamap
- OpenAPI: https://zieapi.vercel.app/api/cloud/azure-purview-datamap/openapi.json

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…

## Endpoints

### Create or update an entity. Existing entity is matched using its unique guid if supplied or by its unique…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| businessAttributeUpdateBehavior | string | no | Used to define the update behavior for business attributes when updating entities. |
| collectionId | string | no | The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. |
| body | object | yes | JSON request body |

### List entities in bulk identified by its GUIDs.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-list-by-guids` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| guid | array | yes | An array of GUIDs of entities to list. |
| minExtInfo | boolean | no | Whether to return minimal information for referred entities. |
| ignoreRelationships | boolean | no | Whether to ignore relationship attributes. |

### Create or update entities in bulk. Existing entity is matched using its unique guid if supplied or by its…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-bulk-create-or-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| collectionId | string | no | The collection where entities will be moved to. Only specify a value if you need to move an entity to another collection. |
| businessAttributeUpdateBehavior | string | no | Used to define the update behavior for business attributes when updating entities. |
| body | object | yes | JSON request body |

### Delete a list of entities in bulk identified by their GUIDs or unique attributes.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-bulk-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | array | yes | An array of GUIDs of entities to delete. |

### Associate a classification to multiple entities in bulk.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-add-classification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| body | object | yes | JSON request body |

### Set classifications on entities in bulk.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-bulk-set-classifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| body | object | yes | JSON request body |

### Bulk API to retrieve list of entities identified by its unique attributes. In addition to the typeName path…
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-list-by-unique-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| typeName | string | yes | The name of the type. |
| minExtInfo | boolean | no | Whether to return minimal information for referred entities. |
| ignoreRelationships | boolean | no | Whether to ignore relationship attributes. |
| attr_N:qualifiedName | string | no | Qualified name of an entity. E.g. to find 2 entities you can set attrs_1:qualifiedName=db1@cl1&attrs_2:qualifiedName=db2@cl1. (This is… |

### Upload the file for creating Business Metadata in BULK
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-import-business-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| body | object | yes | Form fields as a JSON object |

### Get the sample Template for uploading/creating bulk BusinessMetaData
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-get-sample-business-metadata-template` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |

### Get complete definition of an entity given its GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |
| minExtInfo | boolean | no | Whether to return minimal information for referred entities. |
| ignoreRelationships | boolean | no | Whether to ignore relationship attributes. |

### Update entity partially - create or update entity attribute identified by its GUID. Supports only primitive…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-partial-update-attribute-by-guid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |
| name | string | yes | The name of the attribute. |
| body | object | yes | JSON request body |

### Delete an entity identified by its GUID.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |

### Add business metadata to an entity.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-add-or-update-business-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |
| isOverwrite | boolean | no | Whether to overwrite the existing business metadata on the entity or not, default is false. |
| body | object | yes | JSON request body |

### Remove business metadata from an entity.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-remove-business-metadata` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |
| body | object | yes | JSON request body |

### Add or update business metadata attributes.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-add-or-update-business-metadata-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| businessMetadataName | string | yes | BusinessMetadata name |
| guid | string | yes | The globally unique identifier of the entity. |
| body | object | yes | JSON request body |

### Delete business metadata attributes from an entity.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-remove-business-metadata-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| businessMetadataName | string | yes | BusinessMetadata name |
| guid | string | yes | The globally unique identifier of the entity. |
| body | object | yes | JSON request body |

### Get classification for a given entity represented by a GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-get-classification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |
| classificationName | string | yes | The name of the classification. |

### Delete a given classification from an existing entity represented by a GUID.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-remove-classification` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |
| classificationName | string | yes | The name of the classification. |
| suppressDeletedClassification | boolean | no | To prevent classification changes from being overridden during regular scans, set this parameter to true. The default value is false. |

### List classifications for a given entity represented by a GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-get-classifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |

### Add classifications to an existing entity represented by a GUID.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-add-classifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |
| body | object | yes | JSON request body |

### Update classifications to an existing entity represented by a guid.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-update-classifications` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |
| body | object | yes | JSON request body |

### Get entity header given its GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-get-header` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |

### Set labels to a given entity.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-set-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |
| body | object | no | JSON request body |

### Add given labels to a given entity.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-add-label` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |
| body | object | no | JSON request body |

### Delete given labels to a given entity.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-remove-labels` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |
| body | object | no | JSON request body |

### Get complete definition of an entity given its type and unique attribute. In addition to the typeName path…
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-get-by-unique-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| typeName | string | yes | The name of the type. |
| minExtInfo | boolean | no | Whether to return minimal information for referred entities. |
| ignoreRelationships | boolean | no | Whether to ignore relationship attributes. |
| attr:qualifiedName | string | no | The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) |

### Update entity partially - Allow a subset of attributes to be updated on an entity which is identified by its…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-partial-update-by-unique-attributes` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| typeName | string | yes | The name of the type. |
| attr:qualifiedName | string | no | The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) |
| body | object | yes | JSON request body |

### Delete an entity identified by its type and unique attributes. In addition to the typeName path parameter,…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-delete-by-unique-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| typeName | string | yes | The name of the type. |
| attr:qualifiedName | string | no | The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) |

### Delete a given classification from an entity identified by its type and unique attributes.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-remove-classification-by-unique-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| typeName | string | yes | The name of the type. |
| classificationName | string | yes | The name of the classification. |
| attr:qualifiedName | string | no | The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) |

### Add classification to the entity identified by its type and unique attributes.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-add-classifications-by-unique-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| typeName | string | yes | The name of the type. |
| attr:qualifiedName | string | no | The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) |
| body | object | yes | JSON request body |

### Update classification on an entity identified by its type and unique attributes.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-update-classifications-by-unique-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| typeName | string | yes | The name of the type. |
| attr:qualifiedName | string | no | The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) |
| body | object | yes | JSON request body |

### Set labels to a given entity identified by its type and unique attributes. If labels is null/empty, existing…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-set-labels-by-unique-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| typeName | string | yes | The name of the type. |
| attr:qualifiedName | string | no | The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) |
| body | object | no | JSON request body |

### Add given labels to a given entity identified by its type and unique attributes. If labels is null/empty, no…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-add-labels-by-unique-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| typeName | string | yes | The name of the type. |
| attr:qualifiedName | string | no | The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) |
| body | object | no | JSON request body |

### Delete given labels to a given entity identified by its type and unique attribute. If labels is null/empty,…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-remove-labels-by-unique-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| typeName | string | yes | The name of the type. |
| attr:qualifiedName | string | no | The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) |
| body | object | no | JSON request body |

### Get all glossaries. Recommend using limit/offset to get pagination result. Recommend using…
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| limit | integer | no | The page size - by default there is no paging. |
| offset | integer | no | The offset for pagination purpose. |
| sort | string | no | The sort order, ASC (default) or DESC. |
| ignoreTermsAndCategories | boolean | no | Whether ignore terms and categories |

### Create a glossary.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| body | object | yes | JSON request body |

### Get a specific Glossary by its GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| glossaryId | string | yes | The globally unique identifier for glossary. |

### Update the given glossary.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| glossaryId | string | yes | The globally unique identifier for glossary. |
| ignoreTermsAndCategories | boolean | no | Whether ignore terms and categories |
| body | object | yes | JSON request body |

### Delete a glossary. Will delete underlying terms/categories together. Recommend separate delete terms and…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| glossaryId | string | yes | The globally unique identifier for glossary. |

### Get the categories belonging to a specific glossary. Recommend using limit/offset to get pagination result.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-list-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| glossaryId | string | yes | The globally unique identifier for glossary. |
| limit | integer | no | The page size - by default there is no paging. |
| offset | integer | no | The offset for pagination purpose. |
| sort | string | no | The sort order, ASC (default) or DESC. |

### Get the category headers belonging to a specific glossary. Recommend using limit/offset to get pagination…
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-list-categories-headers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| glossaryId | string | yes | The globally unique identifier for glossary. |
| limit | integer | no | The page size - by default there is no paging. |
| offset | integer | no | The offset for pagination purpose. |
| sort | string | no | The sort order, ASC (default) or DESC. |

### Get a specific glossary with detailed information. This API is not recommend. Recommend to fetch…
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-get-detailed` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| glossaryId | string | yes | The globally unique identifier for glossary. |

### Update the glossary partially. Some properties such as qualifiedName are not allowed to be updated. So far…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-partial-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| glossaryId | string | yes | The globally unique identifier for glossary. |
| ignoreTermsAndCategories | boolean | no | Whether ignore terms and categories |
| body | object | yes | JSON request body |

### Get terms belonging to a specific glossary. Recommend using limit/offset to get pagination result.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-list-terms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| glossaryId | string | yes | The globally unique identifier for glossary. |
| limit | integer | no | The page size - by default there is no paging. |
| offset | integer | no | The offset for pagination purpose. |
| sort | string | no | The sort order, ASC (default) or DESC. |

### Get term headers belonging to a specific glossary. Recommend using limit/offset to get pagination result.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-list-term-headers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| glossaryId | string | yes | The globally unique identifier for glossary. |
| limit | integer | no | The page size - by default there is no paging. |
| offset | integer | no | The offset for pagination purpose. |
| sort | string | no | The sort order, ASC (default) or DESC. |

### Create glossary category in bulk.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-create-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| body | object | yes | JSON request body |

### Create a glossary category.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-create-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| body | object | yes | JSON request body |

### Get specific glossary category by its GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-get-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| categoryId | string | yes | The globally unique identifier of the category. |

### Update the given glossary category by its GUID.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-update-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| categoryId | string | yes | The globally unique identifier of the category. |
| body | object | yes | JSON request body |

### Delete a glossary category.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-delete-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| categoryId | string | yes | The globally unique identifier of the category. |

### Update the glossary category partially. So far we only supports partial updating shortDescription and…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-partial-update-category` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| categoryId | string | yes | The globally unique identifier of the category. |
| body | object | yes | JSON request body |

### Get all related categories (parent and children). Limit, offset, and sort parameters are currently not being…
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-list-related-categories` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| categoryId | string | yes | The globally unique identifier of the category. |
| limit | integer | no | The page size - by default there is no paging. |
| offset | integer | no | The offset for pagination purpose. |
| sort | string | no | The sort order, ASC (default) or DESC. |

### Get all terms associated with the specific category.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-list-category-terms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| categoryId | string | yes | The globally unique identifier of the category. |
| limit | integer | no | The page size - by default there is no paging. |
| offset | integer | no | The offset for pagination purpose. |
| sort | string | no | The sort order, ASC (default) or DESC. |

### Create a glossary term.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-create-term` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| includeTermHierarchy | boolean | no | Whether include term hierarchy |
| body | object | yes | JSON request body |

### Get a specific glossary term by its GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-get-term` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| termId | string | yes | The globally unique identifier for glossary term. |

### Update the given glossary term by its GUID.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-update-term` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| termId | string | yes | The globally unique identifier for glossary term. |
| includeTermHierarchy | boolean | no | Whether include term hierarchy |
| body | object | yes | JSON request body |

### Delete a glossary term.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-delete-term` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| termId | string | yes | The globally unique identifier for glossary term. |

### Update the glossary term partially. So far we only supports partial updating shortDescription,…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-partial-update-term` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| termId | string | yes | The globally unique identifier for glossary term. |
| includeTermHierarchy | boolean | no | Whether include term hierarchy |
| body | object | yes | JSON request body |

### Create glossary terms in bulk.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-create-terms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| includeTermHierarchy | boolean | no | Whether include term hierarchy |
| body | object | yes | JSON request body |

### List all related objects assigned with the specified term. Recommend using limit/offset to get pagination…
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-list-entities-assigned-with-term` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| termId | string | yes | The globally unique identifier for glossary term. |
| limit | integer | no | The page size - by default there is no paging. |
| offset | integer | no | The offset for pagination purpose. |
| sort | string | no | The sort order, ASC (default) or DESC. |

### Assign the given term to the provided list of related objects. Recommend using small batches with multiple…
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-assign-term-to-entities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| termId | string | yes | The globally unique identifier for glossary term. |
| body | object | yes | JSON request body |

### Delete the term assignment for the given list of related objects.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-delete-term-assignment-from-entities` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| termId | string | yes | The globally unique identifier for glossary term. |
| body | object | yes | JSON request body |

### Get all related terms for a specific term by its GUID. Limit, offset, and sort parameters are currently not…
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/glossary-list-related-terms` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| termId | string | yes | The globally unique identifier for glossary term. |
| limit | integer | no | The page size - by default there is no paging. |
| offset | integer | no | The offset for pagination purpose. |
| sort | string | no | The sort order, ASC (default) or DESC. |

### Get lineage info of the entity specified by GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/lineage-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |
| depth | integer | no | The number of hops for lineage. |
| direction | string | yes | The direction of the lineage, which could be INPUT, OUTPUT or BOTH. |

### Return lineage info about entity. In addition to the typeName path parameter, attribute key-value pair(s)…
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/lineage-get-by-unique-attribute` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| typeName | string | yes | The name of the type. |
| depth | integer | no | The number of hops for lineage. |
| direction | string | yes | The direction of the lineage, which could be INPUT, OUTPUT or BOTH. |
| attr:qualifiedName | string | no | The qualified name of the entity. (This is only an example. qualifiedName can be changed to other unique attributes) |

### Create a new relationship between entities.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/relationship-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| body | object | yes | JSON request body |

### Update an existing relationship between entities.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/relationship-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| body | object | yes | JSON request body |

### Get relationship information between entities by its GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/relationship-get` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the relationship. |
| extendedInfo | boolean | no | Limits whether includes extended information. |

### Delete a relationship between entities by its GUID.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/relationship-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the relationship. |

### Get the businessMetadata definition for the given guid.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-business-metadata-def-by-guid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | businessMetadata guid |

### Get the businessMetadata definition by it's name (unique).
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-business-metadata-def-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| name | string | yes | businessMetadata name |

### Get the classification definition for the given GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-classification-def-by-guid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the classification. |

### Get the classification definition by its name (unique).
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-classification-def-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| name | string | yes | The name of the classification. |

### Get the Entity definition for the given GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-entity-def-by-guid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the entity. |

### Get the entity definition by its name (unique).
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-entity-def-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| name | string | yes | The name of the entity. |

### Get the enum definition for the given GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-enum-def-by-guid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the enum. |

### Get the enum definition by its name (unique).
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-enum-def-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| name | string | yes | The name of the enum. |

### Get the relationship definition for the given GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-relationship-def-by-guid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the relationship. |

### Get the relationship definition by its name (unique).
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-relationship-def-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| name | string | yes | The name of the relationship. |

### Get the struct definition for the given GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-struct-def-by-guid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the struct. |

### Get the struct definition by its name (unique).
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-struct-def-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| name | string | yes | The name of the struct. |

### Get the type definition for the given GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-by-guid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| guid | string | yes | The globally unique identifier of the type. |

### Get the type definition by its name (unique).
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| name | string | yes | The name of the type. |

### Delete API for type identified by its name.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| name | string | yes | The name of the type. |

### List all type definitions in bulk.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-list` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| includeTermTemplate | boolean | no | Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template |
| type | string | no | Typedef name as search filter when get typedefs. |

### Create all atlas type definitions in bulk. Please avoid recreating existing types.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-bulk-create` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| body | object | yes | JSON request body |

### Update all types in bulk, changes detected in the type definitions would be persisted.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-bulk-update` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| body | object | yes | JSON request body |

### Delete API for all types in bulk.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-bulk-delete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| body | object | yes | JSON request body |

### List all type definitions returned as a list of minimal information header.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-list-headers` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| includeTermTemplate | boolean | no | Whether include termtemplatedef when return all typedefs. This is always true when search filter type=term_template |
| type | string | no | Typedef name as search filter when get typedefs. |

### Move existing entities to the target collection.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-move-entities-to-collection` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| collectionId | string | yes | The collection where entities will be moved to. |
| body | object | yes | JSON request body |

### Return immediate next page lineage info about entity with pagination
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/lineage-get-next-page` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| guid | string | yes | The globally unique identifier of the entity. |
| direction | string | yes | The direction of the lineage, which could be INPUT, OUTPUT or BOTH. |
| offset | integer | no | The offset for pagination purpose. |
| limit | integer | no | The page size - by default there is no paging. |

### Get auto complete options.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/discovery-auto-complete` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| body | object | yes | JSON request body |

### Get data using search.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/discovery-query` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| body | object | yes | JSON request body |

### Get search suggestions by query criteria.
`POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/discovery-suggest` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| body | object | yes | JSON request body |

### Get the term template definition for the given GUID.
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-term-template-def-by-guid` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| guid | string | yes | The globally unique identifier of the term template. |

### Get the term template definition by its name (unique).
`GET https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/type-get-term-template-def-by-name` (byok)

| Parameter | Type | Required | Description |
|---|---|---|---|
| endpoint | string | yes | Your Azure Analytics Purview Data Map endpoint URL, for example https://myresource.azure.com |
| api-version | string | no | The API version to use for this operation. |
| name | string | yes | The unique name of the term template. |

## Example
```
curl "https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-create-or-update" \
  -H "x-api-key: $APIZIE_KEY" \
  -H "x-upstream-key: $PROVIDER_KEY"
```

## FAQ

### How do I call the Azure Analytics Purview Data Map API?
Create a free Apizie key, then send POST https://zieapi.vercel.app/v1/cloud:azure-purview-datamap/entity-create-or-update with the header x-api-key. Every endpoint returns { project, data, timestamp }.

### Is the Azure Analytics Purview Data Map API free on Apizie?
Yes. The Free plan includes 1,000 requests a month at 100 requests a minute, no credit card. Azure Analytics Purview Data Map itself also needs your own key from azure.com.

### Can AI agents use the Azure Analytics Purview Data Map API?
Yes. Add the Apizie MCP server (https://zieapi.vercel.app/mcp) to Claude, ChatGPT, Cursor or VS Code, then ask in plain language. The agent calls run_scraper with project key cloud:azure-purview-datamap.

### What is the status of the Azure Analytics Purview Data Map API?
Needs your own provider key (bring your own key)