Update a glossary term

Update an existing glossary term (partial update).

PATCH /api/data-readiness/glossary/terms/{term_id}

Update a glossary term

cURL

curl --request PATCH \
  --url https://api.example.com/api/data-readiness/glossary/terms/{term_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "term": "<string>",
  "definition": "<string>",
  "domain": "<string>",
  "owner": "<string>",
  "related_terms": [
    "<string>"
  ],
  "data_sources": [
    "<string>"
  ],
  "source_schema": "<string>",
  "source_reference_file": "<string>",
  "custom_tags": [
    "<string>"
  ],
  "conflict_reason": "<string>"
}
'

200

{
  "id": "<string>",
  "term": "<string>",
  "definition": "<string>",
  "domain": "<string>",
  "status": "<string>",
  "owner": "<string>",
  "last_updated": "<string>",
  "version": "<string>",
  "related_terms": [
    "<string>"
  ],
  "usage_count": 0,
  "data_sources": [
    "<string>"
  ],
  "source_schema": "<string>",
  "source_reference_file": "<string>",
  "conflict_reason": "<string>",
  "is_generated": false,
  "custom_tags": [
    "<string>"
  ],
  "resource_uri": "<string>"
}

Authorizations

Authorization · string · header · required

JWT Bearer token authentication. Include the token in the Authorization header as: Authorization: Bearer <token>. The JWT must contain valid client_id, and project_id claims for tenant isolation and SDK routing.

Path Parameters

term_id · string · required

Body

application/json

Request to update an existing glossary term. All fields optional (partial update).

term · string | null

Updated term name

Required string length: 1 - 500

definition · string | null

Updated definition

Minimum string length: 1

domain · string | null

Updated domain

type · enum<string> | null

Updated type

Available options: Concept, Vocabulary

owner · string | null

Updated owner

related_terms · string[] | null

Updated related terms

data_sources · string[] | null

Updated fully qualified table names where this term appears

source_schema · string | null

Updated linked schema FQN

source_reference_file · string | null

Updated source document

custom_tags · string[] | null

Updated tags

conflict_reason · string | null

Updated conflict reason

Response

200

application/json

Successful Response

A single glossary term as returned to the UI.

id · string · required

Term ID (em-runtime Memory ID)

term · string · required

Term name

definition · string · required

Term definition

domain · string · required

Business domain

type · enum<string> · required

Concept or Vocabulary

Available options: Concept, Vocabulary

status · string · required

Verified, Unverified, or Conflicting

owner · string · required

Term owner

last_updated · string · required

Human-readable last updated date

version · string · required

Version number as string

related_terms · string[]

Related term names

usage_count · integer · default: 0

Usage count (placeholder)

data_sources · string[]

Fully qualified table names where this term appears

source_schema · string | null

Linked schema FQN

source_reference_file · string | null

Source reference document

conflict_reason · string | null

Conflict reason (when status=Conflicting)

is_generated · boolean · default: false

Whether AI-generated

custom_tags · string[]

Custom tags

resource_uri · string | null

Parent DB connection resource_uri