Sign in

v3

latestSwagger 2.02026-07-139789260.9 KB

Update the glossary term partially. So far we only supports partial updating shortDescription, longDescription, abbreviation, usage and status for term.

put/atlas/v2/glossary/term/{termId}/partial

Path parameters

termIdstring required

The globally unique identifier for glossary term.

Query parameters

api-versionstring

The API version to use for this operation.

includeTermHierarchyboolean

Whether include term hierarchy

Request body

object required

Response

The request has succeeded.

guidstring

The GUID of the object.

longDescriptionstring

The long version description.

namestring

The name of the glossary object.

qualifiedNamestring

The qualified name of the glossary object.

shortDescriptionstring

The short version of description.

lastModifiedTSstring

ETag for concurrency control.

createTimeinteger

The created time of the record.

createdBystring

The user who created the record.

updateTimeinteger

The update time of the record.

updatedBystring

The user who updated the record.

abbreviationstring

The abbreviation of the term.

status'Draft' | 'Approved' | 'Alert' | 'Expired'

Status for term

nickNamestring

The nick name of the term.

contactsobject

The dictionary of contacts for terms. Key could be Expert or Steward.

attributesobject

The custom attributes of the term, which is map<string,map<string,object>>. The key of the first layer map is term template name.

examplesstring[]

An array of examples.

usagestring

The usage of the term.