---
title: "PUT /atlas/v2/glossary/{glossaryId}/partial"
method: PUT
path: "/atlas/v2/glossary/{glossaryId}/partial"
---

# PUT /atlas/v2/glossary/{glossaryId}/partial

`PUT /atlas/v2/glossary/{glossaryId}/partial`

Update the glossary partially. Some properties such as qualifiedName are not
allowed to be updated.

So far we only supports partial updating
shortDescription, longDescription, language and usage for glossary. 

Recommend
using 'ignoreTermsAndCategories=true' to reduce response body size.

## Path parameters

- `glossaryId` string, required

## Query parameters

- `api-version` string
- `ignoreTermsAndCategories` boolean

## Request body

- object

## Response `200`

The request has succeeded.

- AtlasGlossary — The glossary object.
  - `guid` string — The GUID of the object.
  - `classifications` AtlasClassification[] — An array of classifications.
    - `attributes` object — The attributes of the struct.
    - `typeName` string — The name of the type.
    - `lastModifiedTS` string — ETag for concurrency control.
    - `entityGuid` string — The GUID of the entity.
    - `entityStatus` 'ACTIVE' | 'DELETED' — Status - can be active or deleted
    - `removePropagationsOnEntityDelete` boolean — Determines if propagations will be removed on entity deletion.
    - `validityPeriods` TimeBoundary[] — An array of time boundaries indicating validity periods.
      - `endTime` string — The end of the time boundary.
      - `startTime` string — The start of the time boundary.
      - `timeZone` string — The timezone of the time boundary.
  - `longDescription` string — The long version description.
  - `name` string — The name of the glossary object.
  - `qualifiedName` string — The qualified name of the glossary object.
  - `shortDescription` string — The short version of description.
  - `lastModifiedTS` string — ETag for concurrency control.
  - `createTime` integer — The created time of the record.
  - `createdBy` string — The user who created the record.
  - `updateTime` integer — The update time of the record.
  - `updatedBy` string — The user who updated the record.
  - `categories` AtlasRelatedCategoryHeader[] — An array of categories.
    - `categoryGuid` string — The GUID of the category.
    - `description` string — The description of the category header.
    - `displayText` string — The display text.
    - `parentCategoryGuid` string — The GUID of the parent category.
    - `relationGuid` string — The GUID of the relationship.
  - `language` string — The language of the glossary.
  - `terms` AtlasRelatedTermHeader[] — An array of related term headers.
    - `description` string — The description of the related term.
    - `displayText` string — The display text.
    - `expression` string — The expression of the term.
    - `relationGuid` string — The GUID of the relationship.
    - `status` 'DRAFT' | 'ACTIVE' | 'DEPRECATED' | 'OBSOLETE' | 'OTHER' — Status for atlas term relationship
    - `steward` string — The steward of the term.
    - `termGuid` string — The GUID of the term.
  - `usage` string — The usage of the glossary.

## Other responses

- `default` — An unexpected error response.

---

[API](https://skmtc.net/azure/apis/purview-datamap.md) · [All operations](https://skmtc.net/azure/apis/purview-datamap/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/azure/purview-datamap/revisions/442226cb14a9/schema)