Type alias QuickBaseResponseGetRelationships

QuickBaseResponseGetRelationships: {
    metadata?: {
        numRelationships: number;
        skip: number;
        totalRelationships: number;
    };
    relationships: {
        childTableId: string;
        foreignKeyField?: {
            id: number;
            label: string;
            type: "text" | "text-multiple-choice" | "text-multi-line" | "rich-text" | "numeric" | "currency" | "rating" | "percent" | "multitext" | "email" | "url" | "duration" | "date" | "datetime" | "timestamp" | "timeofday" | "checkbox" | "user" | "multiuser" | "address" | "phone" | "file";
        };
        id: number;
        isCrossApp: boolean;
        lookupFields?: {
            id: number;
            label: string;
            type: "text" | "text-multiple-choice" | "text-multi-line" | "rich-text" | "numeric" | "currency" | "rating" | "percent" | "multitext" | "email" | "url" | "duration" | "date" | "datetime" | "timestamp" | "timeofday" | "checkbox" | "user" | "multiuser" | "address" | "phone" | "file";
        }[];
        parentTableId: string;
        summaryFields?: {
            id: number;
            label: string;
            type: "text" | "text-multiple-choice" | "text-multi-line" | "rich-text" | "numeric" | "currency" | "rating" | "percent" | "multitext" | "email" | "url" | "duration" | "date" | "datetime" | "timestamp" | "timeofday" | "checkbox" | "user" | "multiuser" | "address" | "phone" | "file";
        }[];
    }[];
}

Type declaration

  • Optional metadata?: {
        numRelationships: number;
        skip: number;
        totalRelationships: number;
    }

    Additional information about the results that may be helpful.

    • numRelationships: number

      The number of relationships in the current response object.

    • skip: number

      The number of relationships to skip.

    • totalRelationships: number

      The total number of relationships.

  • relationships: {
        childTableId: string;
        foreignKeyField?: {
            id: number;
            label: string;
            type: "text" | "text-multiple-choice" | "text-multi-line" | "rich-text" | "numeric" | "currency" | "rating" | "percent" | "multitext" | "email" | "url" | "duration" | "date" | "datetime" | "timestamp" | "timeofday" | "checkbox" | "user" | "multiuser" | "address" | "phone" | "file";
        };
        id: number;
        isCrossApp: boolean;
        lookupFields?: {
            id: number;
            label: string;
            type: "text" | "text-multiple-choice" | "text-multi-line" | "rich-text" | "numeric" | "currency" | "rating" | "percent" | "multitext" | "email" | "url" | "duration" | "date" | "datetime" | "timestamp" | "timeofday" | "checkbox" | "user" | "multiuser" | "address" | "phone" | "file";
        }[];
        parentTableId: string;
        summaryFields?: {
            id: number;
            label: string;
            type: "text" | "text-multiple-choice" | "text-multi-line" | "rich-text" | "numeric" | "currency" | "rating" | "percent" | "multitext" | "email" | "url" | "duration" | "date" | "datetime" | "timestamp" | "timeofday" | "checkbox" | "user" | "multiuser" | "address" | "phone" | "file";
        }[];
    }[]

    The relationships in a table.