FileMaker Data API Tools API - v1.9.1
    Preparing search index...

    Function editableAppFields

    • Include previously unchecked source fields so users can select them again without editing JSON.

      Parameters

      • definition: {
            schemaVersion: 1;
            id: string;
            layoutId: string;
            environmentId: string;
            title: string;
            description: string;
            submitLabel: string;
            successMessage: string;
            branding?: { organizationName: string; accentColor: string };
            fields: {
                id: string;
                fmFieldName: string;
                label: string;
                kind: "number" | "text" | "date" | "textarea" | "email" | "select";
                required: boolean;
                helpText: string;
                maxLength: number;
                options?: string[];
            }[];
        }
      • layout: {
            schemaVersion: 1;
            id: string;
            name: string;
            fmLayoutName?: string;
            fieldOrder?: string[];
            canvas: { width: number; height: number; gridSize: number };
            objects: (
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToFmLayout"
                            | "goToWebLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "field";
                    fmFieldName: string;
                    displayType: "checkbox"
                    | "dropdown"
                    | "editBox"
                    | "radio";
                    format: "number" | "text" | "date";
                    dateFormat?: "server" | "iso";
                    kind?: "container" | "calculation" | "summary" | "normal" | "global";
                    metadata?: { type?: string; result?: string };
                    result?: string;
                    multiline?: boolean;
                    options?: string[];
                    label?: string;
                    accessibleLabel?: string;
                    helpText?: string;
                    labelPosition: "none" | "top" | "right" | "left";
                    required: boolean;
                }
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToFmLayout"
                            | "goToWebLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "text";
                    text: string;
                }
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToFmLayout"
                            | "goToWebLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "button";
                    label: string;
                }
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToFmLayout"
                            | "goToWebLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "portal";
                    relatedContext: string;
                    rowCount: number;
                    columns: {
                        id: string;
                        fmFieldName: string;
                        label: string;
                        width: number;
                    }[];
                    scroll: boolean;
                    selectableRows: boolean;
                }
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToFmLayout"
                            | "goToWebLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "rectangle";
                    cornerRadius: number;
                }
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToFmLayout"
                            | "goToWebLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "image";
                    src?: string;
                    alt?: string;
                }
                | {
                    id: string;
                    name: string;
                    x: number;
                    y: number;
                    width: number;
                    height: number;
                    zIndex: number;
                    anchors: { top: boolean; right: boolean; bottom: boolean; left: boolean };
                    style?: { token: string };
                    behavior?: {
                        type?:
                            | "runScript"
                            | "goToFmLayout"
                            | "goToWebLayout"
                            | "openUrl"
                            | "showDialog";
                        scriptName?: string;
                        targetLayoutId?: string;
                        targetFmLayoutName?: string;
                        url?: string;
                        dialogId?: string;
                        parameter?: string;
                    };
                    type: "tabPanel";
                    tabs: { id: string; label: string }[];
                }
            )[];
            styles: {
                colors: {
                    canvas: string;
                    surface: string;
                    text: string;
                    accent: string;
                };
                typography: { fontFamily: string; fontSize: number };
            };
        }

      Returns {
          id: string;
          fmFieldName: string;
          label: string;
          kind: "number" | "text" | "date" | "textarea" | "email" | "select";
          required: boolean;
          helpText: string;
          maxLength: number;
          options?: string[];
      }[]