Microsoft Azure Glossary API

The Glossary API from Microsoft Azure — 28 operation(s) for glossary.

Documentation GitHub OpenAPI

Business capability

Operations 39

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /atlas/v2/glossary List all business glossaries · Microsoft Azure Get Atlas Glossary #

Ask an LLM

“Which glossaries are registered in my Purview data catalog?”

“Can I page through every glossary without pulling all their terms and categories?”

Tell an agent

List all glossaries in the catalog.

List glossaries {limit} at a time starting at offset {offset}, skipping terms and categories.

POST /atlas/v2/glossary Create a new glossary · Microsoft Azure Post Atlas Glossary #

Ask an LLM

“How do I create a new business glossary in Microsoft Purview?”

“Can I set a language and usage note when creating a glossary?”

Tell an agent

Create a new glossary in {language} with usage note {usage}.

Set up a brand new empty glossary for our data catalog.

POST /atlas/v2/glossary/categories Create many glossary categories at once · Microsoft Azure Post Atlas Glossary Categories #

Ask an LLM

“Can I create a batch of glossary categories in a single request?”

“What's the way to bulk-load a list of categories into a glossary?”

Tell an agent

Bulk-create these glossary categories in one call.

Create several glossary categories together from this list.

POST /atlas/v2/glossary/category Create a single glossary category · Microsoft Azure Post Atlas Glossary Category #

Ask an LLM

“How do I add one new category to a glossary?”

“Can a new glossary category be nested under a parent category?”

Tell an agent

Create a category in glossary {anchor}.

Create a category in glossary {anchor} under parent category {parentCategory}.

GET /atlas/v2/glossary/category/{categoryGuid} Get a glossary category by GUID · Microsoft Azure Get Atlas Glossary Category Categoryguid #

Ask an LLM

“How can I look up a single glossary category by its GUID?”

“What details come back for one glossary category?”

Tell an agent

Show me glossary category {categoryGuid}.

Fetch the full record for category {categoryGuid}.

PUT /atlas/v2/glossary/category/{categoryGuid} Replace a glossary category · Microsoft Azure Put Atlas Glossary Category Categoryguid #

Ask an LLM

“How do I fully update an existing glossary category, including its child categories?”

“Can I move a glossary category to a different parent?”

Tell an agent

Update glossary category {categoryGuid} with a full replacement definition.

Set the parent of category {categoryGuid} to {parentCategory}.

DELETE /atlas/v2/glossary/category/{categoryGuid} Delete a glossary category · Microsoft Azure Delete Atlas Glossary Category Categoryguid #

Ask an LLM

“How do I remove a category from a glossary?”

“Is deleting a glossary category permanent?”

Tell an agent destructive · confirm first

Delete glossary category {categoryGuid}.

Remove the category {categoryGuid} from the glossary.

PUT /atlas/v2/glossary/category/{categoryGuid}/partial Edit a category's descriptions only · Microsoft Azure Put Atlas Glossary Category Categoryguid Partial #

Ask an LLM

“Can I change just the short or long description of a glossary category?”

“Which category fields can be updated partially?”

Tell an agent

Partially update the short and long description of category {categoryGuid}.

Patch only the descriptions on glossary category {categoryGuid}.

GET /atlas/v2/glossary/category/{categoryGuid}/related List a category's parent and child categories · Microsoft Azure Get Atlas Glossary Category Categoryguid Related #

Ask an LLM

“What are the parent and child categories of a given glossary category?”

“Does paging work when listing related categories?”

Tell an agent

Show the parent and children of category {categoryGuid}.

List categories related to {categoryGuid}.

GET /atlas/v2/glossary/category/{categoryGuid}/terms List terms in a glossary category · Microsoft Azure Get Atlas Glossary Category Categoryguid Terms #

Ask an LLM

“Which glossary terms are filed under a specific category?”

“Can I sort the terms in a category in descending order?”

Tell an agent

List the terms in category {categoryGuid}.

Get terms of category {categoryGuid} sorted {sort}.

POST /atlas/v2/glossary/term Create a single glossary term · Microsoft Azure Post Atlas Glossary Term #

Ask an LLM

“How do I add a new business term with synonyms and a steward contact?”

“Can I set an abbreviation and status when defining a term?”

Tell an agent

Create a glossary term in glossary {anchor} with abbreviation {abbreviation}.

Add a new term to glossary {anchor} with status {status}.

GET /atlas/v2/glossary/term/{termGuid} Get a glossary term by GUID · Microsoft Azure Get Atlas Glossary Term Termguid #

Ask an LLM

“How do I look up one glossary term and its definition by GUID?”

“Can I exclude semantic assignment relationships when fetching a term?”

Tell an agent

Show glossary term {termGuid}.

Get term {termGuid} excluding relationship types {excludeRelationshipTypes}.

PUT /atlas/v2/glossary/term/{termGuid} Replace a glossary term definition · Microsoft Azure Put Atlas Glossary Term Termguid #

Ask an LLM

“How do I fully update a glossary term, including its related terms?”

“Can I change a term's synonyms and experts in one update?”

Tell an agent

Replace the full definition of term {termGuid}.

Update term {termGuid} to use synonyms {synonyms}.

DELETE /atlas/v2/glossary/term/{termGuid} Delete one glossary term · Microsoft Azure Delete Atlas Glossary Term Termguid #

Ask an LLM

“How do I delete a single term from a glossary?”

“What happens when I remove one glossary term by GUID?”

Tell an agent destructive · confirm first

Delete glossary term {termGuid}.

Remove the single term {termGuid} from its glossary.

PUT /atlas/v2/glossary/term/{termGuid}/partial Edit selected fields on a glossary term · Microsoft Azure Put Atlas Glossary Term Termguid Partial #

Ask an LLM

“Can I change just a term's status or abbreviation without resending everything?”

“Which glossary term fields support a partial update?”

Tell an agent

Partially update the description, usage or status of term {termGuid}.

Patch only the abbreviation on glossary term {termGuid}.

POST /atlas/v2/glossary/terms Create many glossary terms at once · Microsoft Azure Post Atlas Glossary Terms #

Ask an LLM

“Can I create a whole batch of glossary terms in one JSON request?”

“Is there a bulk endpoint for adding terms without a CSV file?”

Tell an agent

Bulk-create these glossary terms in one request.

Create several new terms together and include their term hierarchy.

GET /atlas/v2/glossary/terms/{termGuid}/assignedEntities List data assets tagged with a term · Microsoft Azure Get Atlas Glossary Terms Termguid Assignedentities #

Ask an LLM

“Which data assets have a particular glossary term assigned?”

“Can I page through entities assigned to a term?”

Tell an agent

List assets assigned to term {termGuid}.

Show the first {limit} entities tagged with term {termGuid}.

POST /atlas/v2/glossary/terms/{termGuid}/assignedEntities Assign a term to data assets · Microsoft Azure Post Atlas Glossary Terms Termguid Assignedentities #

Ask an LLM

“How do I tag a set of data assets with a glossary term?”

“Should I assign a term to entities in small batches?”

Tell an agent

Assign term {termGuid} to these data assets.

Tag the listed entities with glossary term {termGuid}.

PUT /atlas/v2/glossary/terms/{termGuid}/assignedEntities Unassign a term via the legacy PUT endpoint · Microsoft Azure Put Atlas Glossary Terms Termguid Assignedentities #

Ask an LLM

“Is there an older PUT-based way to remove a term from data assets?”

“Why is the PUT endpoint for removing term assignments not recommended?”

Tell an agent destructive · confirm first

Use the legacy PUT endpoint to remove term {termGuid} from these assets.

Unassign term {termGuid} from the listed entities with the older PUT call.

DELETE /atlas/v2/glossary/terms/{termGuid}/assignedEntities Remove a term from data assets · Microsoft Azure Delete Atlas Glossary Terms Termguid Assignedentities #

Ask an LLM

“How do I untag data assets from a glossary term?”

“What is the recommended DELETE call for removing term assignments?”

Tell an agent destructive · confirm first

Delete the assignment of term {termGuid} from these assets.

Untag the listed entities from term {termGuid} using DELETE.

GET /atlas/v2/glossary/terms/{termGuid}/related List terms related to a term · Microsoft Azure Get Atlas Glossary Terms Termguid Related #

Ask an LLM

“What synonyms, antonyms and see-also terms are linked to a glossary term?”

“Which terms are related to a given term?”

Tell an agent

List terms related to {termGuid}.

Show the related-term links for glossary term {termGuid}.

GET /atlas/v2/glossary/{glossaryGuid} Get a glossary by GUID · Microsoft Azure Get Atlas Glossary Glossaryguid #

Ask an LLM

“How do I fetch one glossary by its GUID?”

“What basic information does a single glossary record include?”

Tell an agent

Get glossary {glossaryGuid}.

Show the summary for glossary {glossaryGuid}.

PUT /atlas/v2/glossary/{glossaryGuid} Replace a glossary's definition · Microsoft Azure Put Atlas Glossary Glossaryguid #

Ask an LLM

“How do I fully update a glossary's language, usage and contents?”

“Can I update a glossary while ignoring its terms and categories?”

Tell an agent

Replace glossary {glossaryGuid} with the new definition.

Update glossary {glossaryGuid} usage to {usage}.

DELETE /atlas/v2/glossary/{glossaryGuid} Delete a glossary and its contents · Microsoft Azure Delete Atlas Glossary Glossaryguid #

Ask an LLM

“Does deleting a glossary also remove its terms and categories?”

“How do I delete an entire glossary?”

Tell an agent destructive · confirm first

Delete glossary {glossaryGuid} along with its terms and categories.

Remove the whole glossary {glossaryGuid}.

GET /atlas/v2/glossary/{glossaryGuid}/categories List categories in a glossary · Microsoft Azure Get Atlas Glossary Glossaryguid Categories #

Ask an LLM

“Which categories belong to a specific glossary?”

“Can I page through a glossary's full category records?”

Tell an agent

List the categories in glossary {glossaryGuid}.

Get {limit} full categories of glossary {glossaryGuid}.

GET /atlas/v2/glossary/{glossaryGuid}/categories/headers List category headers in a glossary · Microsoft Azure Get Atlas Glossary Glossaryguid Categories Headers #

Ask an LLM

“Can I get just the lightweight headers of a glossary's categories?”

“What's a quick way to list category names and GUIDs for a glossary?”

Tell an agent

List category headers for glossary {glossaryGuid}.

Show just the category names and GUIDs in glossary {glossaryGuid}.

GET /atlas/v2/glossary/{glossaryGuid}/detailed Get a glossary with full term and category detail · Microsoft Azure Get Atlas Glossary Glossaryguid Detailed #

Ask an LLM

“Can I get a glossary with all its terms and categories expanded in one response?”

“Why is the detailed glossary endpoint discouraged?”

Tell an agent

Get the detailed view of glossary {glossaryGuid} with everything expanded.

Fetch glossary {glossaryGuid} including full term and category details.

PUT /atlas/v2/glossary/{glossaryGuid}/partial Edit a glossary's description, language or usage · Microsoft Azure Put Atlas Glossary Glossaryguid Partial #

Ask an LLM

“Can I change only a glossary's language or usage text?”

“Which glossary properties can't be changed with a partial update?”

Tell an agent

Partially update the descriptions of glossary {glossaryGuid}.

Patch only the language and usage on glossary {glossaryGuid}.

GET /atlas/v2/glossary/{glossaryGuid}/terms List terms in a glossary · Microsoft Azure Get Atlas Glossary Glossaryguid Terms #

Ask an LLM

“What terms are defined in a particular glossary?”

“Can I include the term hierarchy when listing a glossary's full terms?”

Tell an agent

List the terms in glossary {glossaryGuid}.

Get full terms from glossary {glossaryGuid} starting at offset {offset}.

GET /atlas/v2/glossary/{glossaryGuid}/terms/headers List term headers in a glossary · Microsoft Azure Get Atlas Glossary Glossaryguid Terms Headers #

Ask an LLM

“Can I list just the names and GUIDs of terms in a glossary?”

“Is there a lighter-weight listing of glossary term headers?”

Tell an agent

List term headers for glossary {glossaryGuid}.

Show only term names and GUIDs in glossary {glossaryGuid}.

POST /glossary/{glossaryGuid}/terms/import Import glossary terms from CSV · Microsoft Azure Post Glossary Glossaryguid Terms Import #

Ask an LLM

“How do I bulk import glossary terms from a CSV file?”

“Can a CSV import include multiple term templates?”

Tell an agent

Import terms from {file} into glossary {glossaryGuid}.

Upload CSV {file} to glossary {glossaryGuid} with multiple templates enabled.

POST /glossary/name/{glossaryName}/terms/import Import CSV terms by glossary name (deprecated) · Microsoft Azure Post Glossary Name Glossaryname Terms Import #

Ask an LLM

“Can I import a CSV of terms using the glossary's name instead of its GUID?”

“Is the import-by-glossary-name endpoint deprecated?”

Tell an agent

Import CSV {file} into the glossary named {glossaryName}.

Use the deprecated name-based import to load {file} into {glossaryName}.

GET /glossary/terms/import/{operationGuid} Check a CSV term import job · Microsoft Azure Get Glossary Terms Import Operationguid #

Ask an LLM

“How can I tell if my glossary CSV import has finished?”

“Did my term import job succeed or fail?”

Tell an agent

Check the status of CSV import {operationGuid}.

Tell me whether term import job {operationGuid} is done.

POST /glossary/{glossaryGuid}/terms/export Export glossary terms to CSV · Microsoft Azure Post Glossary Glossaryguid Terms Export #

Ask an LLM

“How do I export a glossary's terms as a CSV file?”

“Can the CSV export keep rich text formatting?”

Tell an agent

Export the terms of glossary {glossaryGuid} to CSV.

Download glossary {glossaryGuid} terms as CSV with rich text included.

GET /glossary/name/{glossaryName}/terms List terms by glossary name (deprecated) · Microsoft Azure Get Glossary Name Glossaryname Terms #

Ask an LLM

“Can I list terms by the glossary's name rather than its GUID?”

“Does listing terms by glossary name return contact display names?”

Tell an agent

List terms in the glossary named {glossaryName}.

Get terms for glossary name {glossaryName} with extended info.

GET /glossary/terms/bulkDeletion/{operationGuid} Check a bulk term deletion job · Microsoft Azure Get Glossary Terms Bulkdeletion Operationguid #

Ask an LLM

“Has my bulk glossary term deletion finished?”

“Where do I see the progress of a bulk term delete?”

Tell an agent

Check the status of bulk delete {operationGuid}.

Tell me whether term deletion job {operationGuid} completed.

POST /glossary/terms:delete Bulk delete glossary terms · Microsoft Azure Post Glossary Terms:delete #

Ask an LLM

“Can I delete many glossary terms at once?”

“Will a bulk term delete also remove child terms and entity assignments?”

Tell an agent destructive · confirm first

Bulk delete these glossary terms by GUID.

Delete the listed terms, forcing removal of child terms ({forceDeleteChild}).

PUT /glossary/terms Update many glossary terms at once · Microsoft Azure Put Glossary Terms #

Ask an LLM

“Can I update a batch of glossary terms in a single call?”

“Is there a bulk edit endpoint for existing terms?”

Tell an agent

Bulk update these existing glossary terms.

Apply these edits to many terms in one request.

GET /glossary/terms Fetch several terms by their GUIDs · Microsoft Azure Get Glossary Terms #

Ask an LLM

“Can I fetch several specific glossary terms in one call?”

“Is there a way to look up a batch of terms by GUID list?”

Tell an agent

Get the terms with GUIDs {guid}.

Look up this batch of term GUIDs {guid} at once.

Microsoft Azure Glossary API

Operations 39

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification