QuickBase JS SDK v2 - v2.2.2
    Preparing search index...

    Interface GetRelationshipsResponse

    interface GetRelationshipsResponse {
        metadata?: {
            numRelationships?: number;
            skip?: number;
            totalRelationships?: number;
            [key: string]: unknown;
        };
        relationships: {
            childTableId: string;
            foreignKeyField?: {
                id?: number;
                label?: string;
                type?: string;
                [key: string]: unknown;
            };
            id: number;
            isCrossApp: boolean;
            lookupFields?: {
                id?: number;
                label?: string;
                type?: string;
                [key: string]: unknown;
            }[];
            parentTableId: string;
            summaryFields?: {
                id?: number;
                label?: string;
                type?: string;
                [key: string]: unknown;
            }[];
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown
    Index

    Properties

    metadata? relationships

    Properties

    metadata?: {
        numRelationships?: number;
        skip?: number;
        totalRelationships?: number;
        [key: string]: unknown;
    }

    Additional information about the results that may be helpful.

    Type Declaration

    • [key: string]: unknown
    • OptionalnumRelationships?: number

      The number of relationships in the current response object.

    • Optionalskip?: number

      The number of relationships to skip.

    • OptionaltotalRelationships?: number

      The total number of relationships.

    relationships: {
        childTableId: string;
        foreignKeyField?: {
            id?: number;
            label?: string;
            type?: string;
            [key: string]: unknown;
        };
        id: number;
        isCrossApp: boolean;
        lookupFields?: {
            id?: number;
            label?: string;
            type?: string;
            [key: string]: unknown;
        }[];
        parentTableId: string;
        summaryFields?: {
            id?: number;
            label?: string;
            type?: string;
            [key: string]: unknown;
        }[];
        [key: string]: unknown;
    }[]

    The relationships in a table.

    Type Declaration

    • [key: string]: unknown
    • childTableId: string

      The child table id of the relationship.

    • OptionalforeignKeyField?: { id?: number; label?: string; type?: string; [key: string]: unknown }

      The foreign key field information.

      • Optionalid?: number

        Field id.

      • Optionallabel?: string

        Field label.

      • Optionaltype?: string

        Field type.

    • id: number

      The relationship id (foreign key field id).

    • isCrossApp: boolean

      Whether this is a cross-app relationship.

    • OptionallookupFields?: { id?: number; label?: string; type?: string; [key: string]: unknown }[]

      The lookup fields array.

    • parentTableId: string

      The parent table id of the relationship.

    • OptionalsummaryFields?: { id?: number; label?: string; type?: string; [key: string]: unknown }[]

      The summary fields array.

    Settings

    Member Visibility

    On This Page

    Properties