Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace TermSummary

Summary of a term. A defined business term in a business glossary. As well as a term definition, simple format rules for attributes mapping to the term (for example, the expected data type and length restrictions) may be stated at the term level.

Properties

Optional associatedObjectCount

associatedObjectCount: undefined | number

The number of objects tagged with this term. Note: Numbers greater than Number.MAX_SAFE_INTEGER will result in rounding issues.

Optional description

description: undefined | string

Detailed description of the term.

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 glossaryKey

glossaryKey: undefined | string

Unique id of the parent glossary.

Optional isAllowedToHaveChildTerms

isAllowedToHaveChildTerms: undefined | false | true

Indicates whether a term may contain child terms.

key

key: string

Unique term key that is immutable.

Optional lifecycleState

lifecycleState: model.LifecycleState

State of the term.

Optional parentTermKey

parentTermKey: undefined | string

This terms parent term key. Will be null if the term has no parent term.

Optional path

path: undefined | string

Absolute path of the term.

Optional timeCreated

timeCreated: Date

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

Optional uri

uri: undefined | string

URI to the term instance in the API.

Optional workflowStatus

workflowStatus: model.TermWorkflowStatus

Status of the approval process workflow for this business term in the glossary.

Functions

getDeserializedJsonObj

getJsonObj