putPartial.md

pv glossary putPartial

Command Reference > glossary > putPartial

Description

Update the glossary partially.

Syntax

pv glossary putPartial --glossaryGuid=<val> --payloadFile=<val> [--includeTermHierarchy]

Required Arguments

--glossaryGuid (string)
The globally unique identifier for glossary.

--payloadFile (string)
File path to a valid JSON document.

Optional Arguments

--includeTermHierarchy (boolean)
Whether to include the term hierarchy [default: false].

API Mapping

Catalog Data Plane > Glossary > Partial Update Glossary

PUT https://{accountName}.purview.azure.com/catalog/api/atlas/v2/glossary/{glossaryGuid}/partial

Examples

Update an existing glossary.

pv glossary putPartial --glossaryGuid "f2307f48-5834-4709-be85-02f3aea5d149" --payloadFile "/path/to/file.json"

Example payload.

{
    "longDescription": "This is a long description!"
}