Type alias QuickBaseRequestCreateRelationship

QuickBaseRequestCreateRelationship: QuickBaseRequest & {
    childTableId: string;
    foreignKeyField?: {
        label: string;
    };
    lookupFieldIds?: number[];
    parentTableId: string;
    summaryFields?: {
        accumulationType: "AVG" | "SUM" | "MAX" | "MIN" | "STD-DEV" | "COUNT" | "COMBINED-TEXT" | "DISTINCT-COUNT";
        label?: string;
        summaryFid?: number;
        where?: string;
    }[];
}

Type declaration

  • childTableId: string

    The unique identifier (dbid) of the table. This will be the child table.

  • Optional foreignKeyField?: {
        label: string;
    }

    This property is optional. If it is not provided, the foreign key field will be created with the label ‘Related ’, where is the name of a record in the parent table.

    • label: string

      The label for the foreign key field.

  • Optional lookupFieldIds?: number[]

    Array of field ids in the parent table that will become lookup fields in the child table.

  • parentTableId: string

    The parent table id for the relationship.

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

    Array of summary field objects which will turn into summary fields in 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.