Resource: GlossaryTerm
GlossaryTerms are the core of Glossary. A GlossaryTerm holds a rich text description that can be attached to Entries or specific columns to enrich them.
JSON representation |
---|
{ "name" : string , "uid" : string , "displayName" : string , "description" : string , "createTime" : string , "updateTime" : string , "labels" : { string : string , ... } , "parent" : string } |
Fields | |
---|---|
name
|
Output only. Identifier. The resource name of the GlossaryTerm. Format: projects/{project_id_or_number}/locations/{locationId}/glossaries/{glossaryId}/terms/{termId} |
uid
|
Output only. System generated unique id for the GlossaryTerm. This ID will be different if the GlossaryTerm is deleted and re-created with the same name. |
displayName
|
Optional. User friendly display name of the GlossaryTerm. This is user-mutable. This will be same as the GlossaryTermId, if not specified. |
description
|
Optional. The user-mutable description of the GlossaryTerm. |
createTime
|
Output only. The time at which the GlossaryTerm was created. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
updateTime
|
Output only. The time at which the GlossaryTerm was last updated. Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: |
labels
|
Optional. User-defined labels for the GlossaryTerm. An object containing a list of |
parent
|
Required. The immediate parent of the GlossaryTerm in the resource-hierarchy. It can either be a Glossary or a GlossaryCategory. Format: projects/{project_id_or_number}/locations/{locationId}/glossaries/{glossaryId} OR projects/{project_id_or_number}/locations/{locationId}/glossaries/{glossaryId}/categories/{categoryId} |
Methods |
|
---|---|
|
Creates a new GlossaryTerm resource. |
|
Deletes a GlossaryTerm resource. |
|
Gets a GlossaryTerm resource. |
|
Lists GlossaryTerm resources in a Glossary. |
|
Updates a GlossaryTerm resource. |