Interface RelationshipBeta

Represents a relationship between concepts.

interface Relationship {
    additional_properties: string;
    concept: string;
    datasource_id: string;
    description?: string;
    inverse_name: string;
    is_inverse: number;
    is_mtm: number;
    key: string;
    mapping_json: string;
    mapping_name: string;
    mapping_query: string;
    relationship_name: string;
    sort_order: number;
    source_properties: string;
    tables: string;
    target_concept: string;
    target_properties: string;
    transitivity: number;
}

Properties

additional_properties: string

Additional properties associated with the relationship.

concept: string

Source concept in the relationship.

datasource_id: string

Identifier for the data source.

description?: string

Description of the relationship (optional).

inverse_name: string

Inverse name of the relationship.

is_inverse: number

Indicates if the relationship is inverse (1 for true, 0 for false).

is_mtm: number

Indicates if the relationship is many-to-many (1 for true, 0 for false).

key: string

Unique identifier for the relationship.

mapping_json: string

JSON representation of the mapping.

mapping_name: string

Name of the mapping.

mapping_query: string

Query used for mapping the relationship.

relationship_name: string

Name of the relationship.

sort_order: number

Sort order for the relationship.

source_properties: string

Properties of the source concept.

tables: string

Tables involved in the relationship.

target_concept: string

Target concept in the relationship.

target_properties: string

Properties of the target concept.

transitivity: number

Transitivity property of the relationship.