Microsoft Purview

Microsoft Purview Glossary API

Operations for managing glossary terms, categories, and assignments

GitHub OpenAPI
Business capability
Data Governance Management BC-610.10

Operations 19

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 /api/atlas/v2/glossary List all glossaries · Microsoft Purview List all glossaries #
Ask an LLM
“What business glossaries exist in our Purview catalog?”
“Can I list glossaries without loading their terms and categories?”
Tell an agent
List all glossaries.
List glossaries {limit} at a time starting at offset {offset}.
POST /api/atlas/v2/glossary Create a glossary · Microsoft Purview Create a glossary #
Ask an LLM
“How do I start a new business glossary?”
“Can I give a glossary a short and long description when I create it?”
Tell an agent
Create a glossary named {name}.
Create glossary {name} with short description {short}.
GET /api/atlas/v2/glossary/{glossaryId} Get a glossary · Microsoft Purview Get glossary by GUID #
Ask an LLM
“Where can I see the details of one glossary by its GUID?”
“What language and usage notes does a glossary have?”
Tell an agent
Show me glossary {glossary}.
Get the details of glossary {glossary}.
PUT /api/atlas/v2/glossary/{glossaryId} Update a glossary · Microsoft Purview Update a glossary #
Ask an LLM
“How do I rename a glossary or change its description?”
“Can I edit the usage guidance on an existing glossary?”
Tell an agent
Rename glossary {glossary} to {name}.
Set the long description of glossary {glossary} to {long}.
DELETE /api/atlas/v2/glossary/{glossaryId} Delete a glossary with its terms · Microsoft Purview Delete a glossary #
Ask an LLM
“Does deleting a glossary also remove its terms and categories?”
“Can I delete an entire glossary?”
Tell an agent destructive · confirm first
Delete glossary {glossary} and everything in it.
Remove glossary {glossary}.
GET /api/atlas/v2/glossary/{glossaryId}/terms List the terms in a glossary · Microsoft Purview List terms in glossary #
Ask an LLM
“What terms belong to a particular glossary?”
“Can I page and sort the terms of one glossary?”
Tell an agent
List the terms in glossary {glossary}.
List {limit} terms of glossary {glossary} sorted {sort}.
GET /api/atlas/v2/glossary/{glossaryId}/categories List the categories in a glossary · Microsoft Purview List categories in glossary #
Ask an LLM
“What categories organise the terms in a glossary?”
“Can I page through the categories of one glossary?”
Tell an agent
List the categories in glossary {glossary}.
List {limit} categories of glossary {glossary}.
POST /api/atlas/v2/glossary/term Create a glossary term · Microsoft Purview Create a glossary term #
Ask an LLM
“How do I add a single business term to a glossary?”
“Can I give a new term an abbreviation and a status?”
Tell an agent
Create a glossary term {name} anchored to glossary {anchor}.
Add term {name} with abbreviation {abbr} and status {status}.
GET /api/atlas/v2/glossary/term/{termId} Get a glossary term · Microsoft Purview Get glossary term by GUID #
Ask an LLM
“What is the definition of a specific glossary term?”
“Which assets and categories is one term linked to?”
Tell an agent
Show me glossary term {term}.
Get the definition of term {term}.
PUT /api/atlas/v2/glossary/term/{termId} Update a glossary term · Microsoft Purview Update a glossary term #
Ask an LLM
“How do I edit the definition of an existing glossary term?”
“Can I change a term's status from draft to approved?”
Tell an agent
Set the status of glossary term {term} to {status}.
Update the long description of existing term {term} to {long}.
DELETE /api/atlas/v2/glossary/term/{termId} Delete a glossary term · Microsoft Purview Delete a glossary term #
Ask an LLM
“Can I remove a single term from a glossary?”
“What is the way to delete an obsolete glossary term?”
Tell an agent destructive · confirm first
Delete glossary term {term}.
Remove term {term} from its glossary.
POST /api/atlas/v2/glossary/terms Create many glossary terms at once · Microsoft Purview Create glossary terms in bulk #
Ask an LLM
“Can I import a batch of glossary terms in one request?”
“Is there a bulk way to add terms to a glossary?”
Tell an agent
Create these glossary terms in bulk.
Bulk import a list of terms into the glossary.
POST /api/atlas/v2/glossary/category Create a glossary category · Microsoft Purview Create a glossary category #
Ask an LLM
“How do I add a category to group glossary terms?”
“Can a new category be nested under a parent category?”
Tell an agent
Create a glossary category {name} in glossary {anchor}.
Add category {name} under parent category {parent}.
GET /api/atlas/v2/glossary/category/{categoryId} Get a glossary category · Microsoft Purview Get glossary category by GUID #
Ask an LLM
“Which terms and child categories sit inside a glossary category?”
“Where can I see one category by its GUID?”
Tell an agent
Show me glossary category {category}.
Get the terms and children of category {category}.
PUT /api/atlas/v2/glossary/category/{categoryId} Update a glossary category · Microsoft Purview Update a glossary category #
Ask an LLM
“How do I rename a glossary category?”
“Can I move a category under a different parent?”
Tell an agent
Rename glossary category {category} to {name}.
Move category {category} under parent {parent}.
DELETE /api/atlas/v2/glossary/category/{categoryId} Delete a glossary category · Microsoft Purview Delete a glossary category #
Ask an LLM
“Can I delete a category from a glossary?”
“What is the way to remove an unused glossary category?”
Tell an agent destructive · confirm first
Delete glossary category {category}.
Remove category {category}.
GET /api/atlas/v2/glossary/terms/{termId}/assignedEntities List assets tagged with a glossary term · Microsoft Purview List entities assigned with term #
Ask an LLM
“Which data assets have a particular glossary term assigned?”
“Can I page through the entities linked to a term?”
Tell an agent
List the assets assigned glossary term {term}.
Show {limit} entities tagged with term {term}.
POST /api/atlas/v2/glossary/terms/{termId}/assignedEntities Assign a glossary term to assets · Microsoft Purview Assign term to entities #
Ask an LLM
“How do I tag data assets with a business glossary term?”
“Can I link one term to several entities at once?”
Tell an agent
Assign glossary term {term} to the given assets.
Tag these entities with term {term}.
DELETE /api/atlas/v2/glossary/terms/{termId}/assignedEntities Unassign a glossary term from assets · Microsoft Purview Remove term assignment from entities #
Ask an LLM
“How do I remove a glossary term from assets it was assigned to?”
“Can I unlink a term from specific entities?”
Tell an agent destructive · confirm first
Remove the assignment of term {term} from the given assets.
Untag these entities from glossary term {term}.

Documentation

📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/
📖
Authentication
https://learn.microsoft.com/en-us/purview/tutorial-using-rest-apis
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/data-gov-api-create-assets
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/scanning
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/account
📖
Authentication
https://learn.microsoft.com/en-us/azure/active-directory/develop/v2-oauth2-client-creds-grant-flow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/datamap
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/how-to-purview-custom-lineage-api-user-guide
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/metadatapolicies
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/legacy/tutorial-metadata-policy-collections-apis
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/workflow
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-api-overview
📖
Authentication
https://learn.microsoft.com/en-us/purview/data-gov-api-rest-data-plane
📖
Documentation
https://learn.microsoft.com/en-us/rest/api/purview/unified-catalog-data-quality
📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/security-ediscovery-apioverview?view=graph-rest-1.0
📖
Authentication
https://learn.microsoft.com/en-us/graph/security-ediscovery-appauthsetup
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/edisc-ref-api-guide
📖
Documentation
https://learn.microsoft.com/en-us/graph/security-information-protection-overview
📖
Documentation
https://learn.microsoft.com/en-us/graph/security-datasecurityandgovernance-overview
📖
GettingStarted
https://learn.microsoft.com/en-us/purview/developer/use-the-api
📖
Documentation
https://learn.microsoft.com/en-us/graph/api/resources/security-recordsmanagement-overview?view=graph-rest-1.0

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/microsoft-purview/refs/heads/main/openapi/microsoft-purview-glossary-api-openapi.yml

Other Resources

🔗
Pricing
https://azure.microsoft.com/en-us/pricing/details/purview/
🔗
Reference
https://learn.microsoft.com/en-us/purview/data-map-data-sources
🔗
Reference
https://learn.microsoft.com/en-us/purview/unified-catalog-data-quality
🔗
Reference
https://learn.microsoft.com/en-us/purview/sensitivity-labels
🔗
Reference
https://learn.microsoft.com/en-us/purview/developer/
🔗
Reference
https://learn.microsoft.com/en-us/graph/compliance-concept-overview

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/microsoft-purview:microsoft-purview-glossary-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

microsoft-purview-glossary-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Microsoft Purview Glossary API
  contact:
    name: Microsoft Purview Support
    url: https://learn.microsoft.com/en-us/purview/
  license:
    name: Microsoft API License
    url: https://azure.microsoft.com/en-us/support/legal/
  version: '1.0'
  description: 'Operations tagged Glossary across 2 of this provider''s published API definitions: microsoft-purview-catalog-openapi.yml, microsoft-purview-data-map-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://{accountName}.purview.azure.com/catalog
  description: Microsoft Purview Catalog API endpoint
  variables:
    accountName:
      description: The name of the Microsoft Purview account
      default: myaccount
- url: https://{accountName}.purview.azure.com/datamap
  description: Microsoft Purview Data Map API endpoint
  variables:
    accountName:
      description: The name of the Microsoft Purview account
      default: myaccount
security:
- oauth2: []
tags:
- name: Glossary
  description: Operations for managing glossary terms, categories, and assignments
paths:
  /api/atlas/v2/glossary:
    get:
      operationId: listGlossaries
      summary: Microsoft Purview List all glossaries
      description: Get all glossaries. Recommend using limit/offset to get pagination result.
      tags:
      - Glossary
      parameters:
      - name: limit
        in: query
        description: The page size - by default there is no paging
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        description: The offset for pagination purpose
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        description: The sort order - ASC or DESC
        schema:
          type: string
          enum:
          - ASC
          - DESC
      - name: ignoreTermsAndCategories
        in: query
        description: Whether to ignore terms and categories
        schema:
          type: boolean
          default: false
      responses:
        '200':
          description: Glossaries retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AtlasGlossary'
        '401':
          description: Unauthorized
    post:
      operationId: createGlossary
      summary: Microsoft Purview Create a glossary
      description: Create a glossary.
      tags:
      - Glossary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasGlossary'
      responses:
        '200':
          description: Glossary created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossary'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
  /api/atlas/v2/glossary/{glossaryId}:
    get:
      operationId: getGlossary
      summary: Microsoft Purview Get glossary by GUID
      description: Get a specific Glossary by its GUID.
      tags:
      - Glossary
      parameters:
      - name: glossaryId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Glossary retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossary'
        '401':
          description: Unauthorized
        '404':
          description: Glossary not found
    put:
      operationId: updateGlossary
      summary: Microsoft Purview Update a glossary
      description: Update the given glossary.
      tags:
      - Glossary
      parameters:
      - name: glossaryId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasGlossary'
      responses:
        '200':
          description: Glossary updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossary'
        '401':
          description: Unauthorized
    delete:
      operationId: deleteGlossary
      summary: Microsoft Purview Delete a glossary
      description: Delete a glossary. Will delete underlying terms/categories together.
      tags:
      - Glossary
      parameters:
      - name: glossaryId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Glossary deleted successfully
        '401':
          description: Unauthorized
        '404':
          description: Glossary not found
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
  /api/atlas/v2/glossary/{glossaryId}/terms:
    get:
      operationId: listGlossaryTerms
      summary: Microsoft Purview List terms in glossary
      description: Get terms belonging to a specific glossary.
      tags:
      - Glossary
      parameters:
      - name: glossaryId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: limit
        in: query
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        schema:
          type: string
          enum:
          - ASC
          - DESC
      responses:
        '200':
          description: Terms retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AtlasGlossaryTerm'
        '401':
          description: Unauthorized
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
  /api/atlas/v2/glossary/{glossaryId}/categories:
    get:
      operationId: listGlossaryCategories
      summary: Microsoft Purview List categories in glossary
      description: Get the categories belonging to a specific glossary.
      tags:
      - Glossary
      parameters:
      - name: glossaryId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: limit
        in: query
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        schema:
          type: string
          enum:
          - ASC
          - DESC
      responses:
        '200':
          description: Categories retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AtlasGlossaryCategory'
        '401':
          description: Unauthorized
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
  /api/atlas/v2/glossary/term:
    post:
      operationId: createGlossaryTerm
      summary: Microsoft Purview Create a glossary term
      description: Create a glossary term.
      tags:
      - Glossary
      parameters:
      - name: includeTermHierarchy
        in: query
        description: Whether to include the term hierarchy
        schema:
          type: boolean
          default: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasGlossaryTerm'
      responses:
        '200':
          description: Term created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossaryTerm'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
  /api/atlas/v2/glossary/term/{termId}:
    get:
      operationId: getGlossaryTerm
      summary: Microsoft Purview Get glossary term by GUID
      description: Get a specific glossary term by its GUID.
      tags:
      - Glossary
      parameters:
      - name: termId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Term retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossaryTerm'
        '401':
          description: Unauthorized
        '404':
          description: Term not found
    put:
      operationId: updateGlossaryTerm
      summary: Microsoft Purview Update a glossary term
      description: Update the given glossary term by its GUID.
      tags:
      - Glossary
      parameters:
      - name: termId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: includeTermHierarchy
        in: query
        schema:
          type: boolean
          default: false
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasGlossaryTerm'
      responses:
        '200':
          description: Term updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossaryTerm'
        '401':
          description: Unauthorized
    delete:
      operationId: deleteGlossaryTerm
      summary: Microsoft Purview Delete a glossary term
      description: Delete a glossary term.
      tags:
      - Glossary
      parameters:
      - name: termId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Term deleted successfully
        '401':
          description: Unauthorized
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
  /api/atlas/v2/glossary/terms:
    post:
      operationId: createGlossaryTerms
      summary: Microsoft Purview Create glossary terms in bulk
      description: Create glossary terms in bulk.
      tags:
      - Glossary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AtlasGlossaryTerm'
      responses:
        '200':
          description: Terms created successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AtlasGlossaryTerm'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
  /api/atlas/v2/glossary/category:
    post:
      operationId: createGlossaryCategory
      summary: Microsoft Purview Create a glossary category
      description: Create a glossary category.
      tags:
      - Glossary
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasGlossaryCategory'
      responses:
        '200':
          description: Category created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossaryCategory'
        '400':
          description: Bad request
        '401':
          description: Unauthorized
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
  /api/atlas/v2/glossary/category/{categoryId}:
    get:
      operationId: getGlossaryCategory
      summary: Microsoft Purview Get glossary category by GUID
      description: Get specific glossary category by its GUID.
      tags:
      - Glossary
      parameters:
      - name: categoryId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Category retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossaryCategory'
        '401':
          description: Unauthorized
        '404':
          description: Category not found
    put:
      operationId: updateGlossaryCategory
      summary: Microsoft Purview Update a glossary category
      description: Update the given glossary category by its GUID.
      tags:
      - Glossary
      parameters:
      - name: categoryId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AtlasGlossaryCategory'
      responses:
        '200':
          description: Category updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AtlasGlossaryCategory'
        '401':
          description: Unauthorized
    delete:
      operationId: deleteGlossaryCategory
      summary: Microsoft Purview Delete a glossary category
      description: Delete a glossary category.
      tags:
      - Glossary
      parameters:
      - name: categoryId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '204':
          description: Category deleted successfully
        '401':
          description: Unauthorized
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
  /api/atlas/v2/glossary/terms/{termId}/assignedEntities:
    get:
      operationId: listEntitiesAssignedWithTerm
      summary: Microsoft Purview List entities assigned with term
      description: List all related objects assigned with the specified term.
      tags:
      - Glossary
      parameters:
      - name: termId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      - name: limit
        in: query
        schema:
          type: integer
          format: int32
      - name: offset
        in: query
        schema:
          type: integer
          format: int32
      - name: sort
        in: query
        schema:
          type: string
          enum:
          - ASC
          - DESC
      responses:
        '200':
          description: Assigned entities retrieved successfully
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AtlasRelatedObjectId'
        '401':
          description: Unauthorized
    post:
      operationId: assignTermToEntities
      summary: Microsoft Purview Assign term to entities
      description: Assign the given term to the provided list of related objects.
      tags:
      - Glossary
      parameters:
      - name: termId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AtlasRelatedObjectId'
      responses:
        '204':
          description: Term assigned successfully
        '401':
          description: Unauthorized
    delete:
      operationId: deleteTermAssignmentFromEntities
      summary: Microsoft Purview Remove term assignment from entities
      description: Delete the term assignment for the given list of related objects.
      tags:
      - Glossary
      parameters:
      - name: termId
        in: path
        required: true
        schema:
          type: string
          format: uuid
      requestBody:
        content:
          application/json:
            schema:
              type: array
              items:
                $ref: '#/components/schemas/AtlasRelatedObjectId'
      responses:
        '204':
          description: Term assignment removed successfully
        '401':
          description: Unauthorized
    servers:
    - url: https://{accountName}.purview.azure.com/catalog
      description: Microsoft Purview Catalog API endpoint
      variables:
        accountName:
          description: The name of the Microsoft Purview account
          default: myaccount
components:
  schemas:
    ResourceLink:
      type: object
      properties:
        displayName:
          type: string
        url:
          type: string
          format: uri
    AtlasGlossaryCategory:
      type: object
      description: A glossary category
      properties:
        guid:
          type: string
          format: uuid
        qualifiedName:
          type: string
        name:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        anchor:
          $ref: '#/components/schemas/AtlasGlossaryHeader'
        parentCategory:
          $ref: '#/components/schemas/AtlasRelatedCategoryHeader'
        childrenCategories:
          type: array
          items:
            $ref: '#/components/schemas/AtlasRelatedCategoryHeader'
        terms:
          type: array
          items:
            $ref: '#/components/schemas/AtlasRelatedTermHeader'
    AtlasTermCategorizationHeader:
      type: object
      properties:
        categoryGuid:
          type: string
          format: uuid
        description:
          type: string
        displayText:
          type: string
        relationGuid:
          type: string
          format: uuid
        status:
          type: string
    TimeBoundary:
      type: object
      properties:
        endTime:
          type: string
        startTime:
          type: string
        timeZone:
          type: string
    AtlasClassification:
      type: object
      description: A classification instance
      properties:
        attributes:
          type: object
          additionalProperties: true
        typeName:
          type: string
        lastModifiedTS:
          type: string
        entityGuid:
          type: string
          format: uuid
        entityStatus:
          type: string
          enum:
          - ACTIVE
          - DELETED
        propagate:
          type: boolean
        removePropagationsOnEntityDelete:
          type: boolean
        validityPeriods:
          type: array
          items:
            $ref: '#/components/schemas/TimeBoundary'
    AtlasRelatedTermHeader:
      type: object
      properties:
        description:
          type: string
        displayText:
          type: string
        expression:
          type: string
        relationGuid:
          type: string
          format: uuid
        status:
          type: string
          enum:
          - DRAFT
          - ACTIVE
          - DEPRECATED
          - OBSOLETE
          - OTHER
        steward:
          type: string
        termGuid:
          type: string
          format: uuid
    AtlasGlossaryTerm:
      type: object
      description: A glossary term
      properties:
        guid:
          type: string
          format: uuid
        qualifiedName:
          type: string
        name:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        abbreviation:
          type: string
        usage:
          type: string
        status:
          type: string
          enum:
          - Draft
          - Approved
          - Alert
          - Expired
        anchor:
          $ref: '#/components/schemas/AtlasGlossaryHeader'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/AtlasTermCategorizationHeader'
        classifications:
          type: array
          items:
            $ref: '#/components/schemas/AtlasClassification'
        assignedEntities:
          type: array
          items:
            $ref: '#/components/schemas/AtlasRelatedObjectId'
        resources:
          type: array
          items:
            $ref: '#/components/schemas/ResourceLink'
    AtlasRelatedObjectId:
      type: object
      properties:
        displayText:
          type: string
        guid:
          type: string
          format: uuid
        relationshipAttributes:
          type: object
        relationshipGuid:
          type: string
          format: uuid
        relationshipStatus:
          type: string
          enum:
          - ACTIVE
          - DELETED
        relationshipType:
          type: string
        typeName:
          type: string
        uniqueAttributes:
          type: object
          additionalProperties: true
    AtlasRelatedCategoryHeader:
      type: object
      properties:
        categoryGuid:
          type: string
          format: uuid
        description:
          type: string
        displayText:
          type: string
        parentCategoryGuid:
          type: string
          format: uuid
        relationGuid:
          type: string
          format: uuid
    AtlasGlossaryHeader:
      type: object
      properties:
        displayText:
          type: string
        glossaryGuid:
          type: string
          format: uuid
        relationGuid:
          type: string
          format: uuid
    AtlasGlossary:
      type: object
      description: A glossary object
      properties:
        guid:
          type: string
          format: uuid
        qualifiedName:
          type: string
        name:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        language:
          type: string
        usage:
          type: string
        terms:
          type: array
          items:
            $ref: '#/components/schemas/AtlasRelatedTermHeader'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/AtlasRelatedCategoryHeader'
    AtlasRelatedTermHeader_2:
      type: object
      properties:
        displayText:
          type: string
        relationGuid:
          type: string
          format: uuid
        termGuid:
          type: string
          format: uuid
    AtlasGlossaryTerm_2:
      type: object
      properties:
        guid:
          type: string
          format: uuid
        qualifiedName:
          type: string
        name:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        abbreviation:
          type: string
        status:
          type: string
          enum:
          - Draft
          - Approved
          - Alert
          - Expired
        anchor:
          $ref: '#/components/schemas/AtlasGlossaryHeader'
    AtlasRelatedCategoryHeader_2:
      type: object
      properties:
        categoryGuid:
          type: string
          format: uuid
        displayText:
          type: string
        relationGuid:
          type: string
          format: uuid
    AtlasGlossary_2:
      type: object
      properties:
        guid:
          type: string
          format: uuid
        qualifiedName:
          type: string
        name:
          type: string
        shortDescription:
          type: string
        longDescription:
          type: string
        language:
          type: string
        usage:
          type: string
        terms:
          type: array
          items:
            $ref: '#/components/schemas/AtlasRelatedTermHeader_2'
        categories:
          type: array
          items:
            $ref: '#/components/schemas/AtlasRelatedCategoryHeader_2'
  securitySchemes:
    oauth2:
      type: oauth2
      description: Azure Active Directory OAuth2 authentication
      flows:
        clientCredentials:
          tokenUrl: https://login.microsoftonline.com/{tenantId}/oauth2/v2.0/token
          scopes:
            https://purview.azure.net/.default: Access Microsoft Purview
x-refined-from:
- microsoft-purview-catalog-openapi.yml
- microsoft-purview-data-map-openapi.yml