ModelingRelationship

Relationship definition used in the models when joining across tables columns.

API Section: Objects

Type: Object

Properties

Name

Description

Required

Type

Format

relationshipId

The relationship's system ID

-

string

uuid

columns

The model's system ID

-

ModelingRelationshipColumnPair []

primaryTableUniqueName

The primary table's unique name

-

string

foreignTableUniqueName

The foreign table's unique name

-

string

type

The join type (inner, right, left, full outer, or cross join)

-

JoinType

isBiDirectional

Boolean indicating if the join is bi-directional

-

boolean