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

    Interface UpdateRelationshipRequest

    interface UpdateRelationshipRequest {
        lookupFieldIds?: number[];
        summaryFields?: {
            accumulationType:
                | "AVG"
                | "SUM"
                | "MAX"
                | "MIN"
                | "STD-DEV"
                | "COUNT"
                | "COMBINED-TEXT"
                | "COMBINED-USER"
                | "DISTINCT-COUNT";
            label?: string;
            summaryFid?: number;
            where?: string;
            [key: string]: unknown;
        }[];
    }
    Index

    Properties

    lookupFieldIds? summaryFields?

    Properties

    lookupFieldIds?: number[]

    An array of field ids on the parent table that will become lookup fields on the child table.

    summaryFields?: {
        accumulationType:
            | "AVG"
            | "SUM"
            | "MAX"
            | "MIN"
            | "STD-DEV"
            | "COUNT"
            | "COMBINED-TEXT"
            | "COMBINED-USER"
            | "DISTINCT-COUNT";
        label?: string;
        summaryFid?: number;
        where?: string;
        [key: string]: unknown;
    }[]

    An array of objects, each representing a configuration of one field from the child table, that will become summary fields on the parent table. When you specify the 'COUNT' accumulation type, you have to specify 0 as the summaryFid (or not set it in the request). 'DISTINCT-COUNT' requires that summaryFid be set to an actual fid.

    Type Declaration

    • [key: string]: unknown
    • accumulationType:
          | "AVG"
          | "SUM"
          | "MAX"
          | "MIN"
          | "STD-DEV"
          | "COUNT"
          | "COMBINED-TEXT"
          | "COMBINED-USER"
          | "DISTINCT-COUNT"

      The accumulation type for the summary field.

    • Optionallabel?: string

      The label for the summary field.

    • OptionalsummaryFid?: number

      The field id to summarize.

    • Optionalwhere?: string

      The filter, using the Quickbase query language, which determines the records to return.

    Settings

    Member Visibility

    On This Page

    Properties