Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace TermRelationshipSummary

Summary of a term relationship. Business term relationship between two terms in a business glossary.

Properties

Optional description

description: undefined | string

Detailed description of the term relationship usually defined at the time of creation.

Optional displayName

displayName: undefined | string

A user-friendly display name. Does not have to be unique, and it's changeable. Avoid entering confidential information.This is the same as relationshipType for termRelationship

key

key: string

Unique term relationship key that is immutable.

Optional lifecycleState

lifecycleState: model.LifecycleState

State of the term relationship.

Optional parentTermDescription

parentTermDescription: undefined | string

Description of the parent term.

Optional parentTermDisplayName

parentTermDisplayName: undefined | string

Name of the parent term.

Optional parentTermGlossaryKey

parentTermGlossaryKey: undefined | string

Glossary key of the parent term.

Optional parentTermKey

parentTermKey: undefined | string

This relationships parent term key.

Optional parentTermPath

parentTermPath: undefined | string

Full path of the parent term.

Optional relatedTermDescription

relatedTermDescription: undefined | string

Description of the related term.

Optional relatedTermDisplayName

relatedTermDisplayName: undefined | string

Name of the related term.

Optional relatedTermGlossaryKey

relatedTermGlossaryKey: undefined | string

Glossary key of the related term.

Optional relatedTermKey

relatedTermKey: undefined | string

Unique id of the related term.

Optional relatedTermPath

relatedTermPath: undefined | string

Full path of the related term.

Optional timeCreated

timeCreated: Date

The date and time the term relationship 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 relationship instance in the API.

Functions

getDeserializedJsonObj

getJsonObj