nodes/generated

Interface FileMakerNodeParameters

Source


interface FileMakerNodeParameters {
    action?:
        | "create"
        | "delete"
        | "record"
        | "edit"
        | "find"
        | "duplicate"
        | "records"
        | "performscript";
    fieldsParametersUi?: {
        fields: { name?: string; value?: string }[];
    };
    getPortals?: boolean;
    layout?: string;
    limit?: number;
    modId?: number;
    offset?: number;
    portals?: string;
    queries?: {
        query: {
            fields?: {
                field: { name?: string; value?: string }[];
            };
            omit?: boolean;
        }[];
    };
    recid?: number;
    responseLayout?: string;
    script?: string;
    scriptAfter?: string;
    scriptAfterParam?: string;
    scriptBefore?: string;
    scriptBeforeParam?: string;
    scriptParam?: string;
    scriptSort?: string;
    scriptSortParam?: string;
    setScriptAfter?: boolean;
    setScriptBefore?: boolean;
    setScriptSort?: boolean;
    setSort?: boolean;
    sortParametersUi?: {
        rules: {
            name?: string;
            value?: "ascend"
            | "descend";
        }[];
    };
}

Properties§

§readonly action?:
    | "create"
    | "delete"
    | "record"
    | "edit"
    | "find"
    | "duplicate"
    | "records"
    | "performscript"

Default: "record"

§readonly fieldsParametersUi?: { ... }

Fields to define Default: {} Type options: {"multipleValues":true}

§readonly getPortals?: boolean

Whether to get portal data as well

§readonly layout?: string

FileMaker Layout Name. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getLayouts"}

§readonly limit?: number

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

§readonly modId?: number

The last modification ID. When you use modId, a record is edited only when the modId matches.

§readonly offset?: number

The record number of the first record in the range of records Default: 1

§readonly portals?: string

The portal result set to return. Use the portal object name or portal table name. If this parameter is omitted, the API will return all portal objects and records in the layout. For best performance, pass the portal object name or portal table name. Choose from the list, or specify an ID using an expression. Default: [] Type options: {"multipleValues":true,"multipleValueButtonText":"Add portal","loadOptionsMethod":"getPortals"}

§readonly queries?: { ... }

Default: {} Type options: {"multipleValues":true}

§readonly recid?: number

Internal Record ID returned by get (recordid)

§readonly responseLayout?: string

Choose from the list, or specify an ID using an expression Type options: {"loadOptionsMethod":"getResponseLayouts"}

§readonly script?: string

The name of the FileMaker script to be run. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getScripts"}

§readonly scriptAfter?: string

The name of the FileMaker script to be run after the action specified by the API call and after the subsequent sort. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getScripts"}

§readonly scriptAfterParam?: string

A parameter for the FileMaker script

§readonly scriptBefore?: string

The name of the FileMaker script to be run after the action specified by the API call and after the subsequent sort. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getScripts"}

§readonly scriptBeforeParam?: string

A parameter for the FileMaker script

§readonly scriptParam?: string

A parameter for the FileMaker script

§readonly scriptSort?: string

The name of the FileMaker script to be run after the action specified by the API call but before the subsequent sort. Choose from the list, or specify an ID using an expression. Type options: {"loadOptionsMethod":"getScripts"}

§readonly scriptSortParam?: string

A parameter for the FileMaker script

§readonly setScriptAfter?: boolean

Whether to define a script to be run after the action specified by the API call but before the subsequent sort

§readonly setScriptBefore?: boolean

Whether to define a script to be run before the action specified by the API call and after the subsequent sort

§readonly setScriptSort?: boolean

Whether to define a script to be run after the action specified by the API call but before the subsequent sort

§readonly setSort?: boolean

Whether to sort data

§readonly sortParametersUi?: { ... }

Sort rules Default: {} Type options: {"multipleValues":true}