nodes/generated

Interface GristNodeParameters

Source


interface GristNodeParameters {
    additionalOptions?: {
        filter?: {
            filterProperties: {
                field: string;
                values?: string;
            }[];
        };
        sort?: {
            sortProperties: {
                direction?: "asc"
                | "desc";
                field: string;
            }[];
        };
    };
    dataToSend?: "autoMapInputs"
    | "defineInNode";
    docId?: string;
    fieldsToSend?: {
        properties: {
            fieldId?: string;
            fieldValue?: string;
        }[];
    };
    inputsToIgnore?: string;
    limit?: number;
    operation?: "create"
    | "getAll"
    | "update"
    | "delete";
    returnAll?: boolean;
    rowId?: string;
    tableId?: string;
}

Properties§

§readonly additionalOptions?: { ... }

Default: {}

§readonly dataToSend?: "autoMapInputs" | "defineInNode"

Whether to insert the input data this node receives in the new row Default: "defineInNode"

§readonly docId?: string

In your document, click your profile icon, then Document Settings, then copy the value under "This document's ID"

§readonly fieldsToSend?: { ... }

Default: {} Type options: {"multipleValueButtonText":"Add Field to Send","multipleValues":true}

§readonly inputsToIgnore?: string

List of input properties to avoid sending, separated by commas. Leave empty to send all properties.

§readonly limit?: number

Max number of results to return Default: 50 Type options: {"minValue":1}

§readonly operation?: "create" | "getAll" | "update" | "delete"

Default: "getAll"

§readonly returnAll?: boolean

Whether to return all results or only up to a given limit

§readonly rowId?: string

ID of the row to delete, or comma-separated list of row IDs to delete

§readonly tableId?: string

ID of table to operate on. If unsure, look at the Code View.