putTerm.md

pv glossary putTerm

Command Reference > glossary > putTerm

Description

Update the given glossary term by its GUID.

Syntax

pv glossary putTerm --termGuid=<val> --payloadFile=<val> [--includeTermHierarchy]

Required Arguments

--termGuid (string)
The globally unique identifier for glossary term.

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

Optional Arguments

--includeTermHierarchy (boolean)
Whether to include the term hierarchy.

API Mapping

Catalog Data Plane > Glossary > Update Glossary Term

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

Examples

Update an existing glossary term.

pv glossary putTerm --termGuid "919e8f87-d5b2-4dde-9f6e-1bbd738536a1" --payloadFile "/path/to/file.json"

Example payload.

{
    "anchor": {
        "glossaryGuid": "125e2575-5823-4887-89f0-ff03a70f7c3a"
    },
    "name": "My Term",
    "qualifiedName": "My Term@Glossary",
    "longDescription": "Hello World!",
    "status": "Approved"
}