• Public
  • Public/Protected
  • All

Namespace Glossary

Full glossary details. A glossary of business terms, such as 'Customer', 'Account', 'Contact' , 'Address', or 'Product', with definitions, used to provide common meaning across disparate data assets. Business glossaries may be hierarchical where some terms may contain child terms to allow them to be used as 'taxonomies'. By linking data assets, data entities, and attributes to glossaries and glossary terms, the glossary can act as a way of organizing data catalog objects in a hierarchy to make a large number of objects more navigable and easier to consume. Objects in the data aatalog, such as data assets or data entities, may be linked to any level in the glossary, so that the glossary can be used to browse the available data according to the business model of the organization.


Optional catalogId

catalogId: undefined | string

The data catalog's OCID.

Optional createdById

createdById: undefined | string

OCID of the user who created this metadata element.

Optional customPropertyMembers

customPropertyMembers: Array<CustomPropertyGetUsage>

The list of customized properties along with the values for this object

Optional description

description: undefined | string

Detailed description of the glossary.

Optional displayName

displayName: undefined | string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Optional importJobDefinitionKey

importJobDefinitionKey: undefined | string

The unique key of the job definition resource that was used in the Glossary import.

Optional importJobKey

importJobKey: undefined | string

The unique key of the job policy for Glossary import.


key: string

Unique glossary key that is immutable.

Optional latestImportJobExecutionKey

latestImportJobExecutionKey: undefined | string

The unique key of the parent job execution for which the log resource was created.

Optional latestImportJobExecutionStatus

latestImportJobExecutionStatus: undefined | string

Status of the latest glossary import job execution, such as running, paused, or completed. This may include additional information like time import started , import file size and % of completion

Optional lifecycleState

lifecycleState: model.LifecycleState

The current state of the glossary.

Optional owner

owner: undefined | string

OCID of the user who is the owner of the glossary.

Optional timeCreated

timeCreated: Date

The date and time the glossary was created, in the format defined by RFC3339. Example: 2019-03-25T21:10:29.600Z

Optional timeUpdated

timeUpdated: Date

The last time that any change was made to the glossary. An RFC3339 formatted datetime string.

Optional updatedById

updatedById: undefined | string

OCID of the user who updated this metadata element.

Optional uri

uri: undefined | string

URI to the tag instance in the API.

Optional workflowStatus

workflowStatus: model.TermWorkflowStatus

Status of the approval process workflow for this business glossary.