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

    Interface SelfTestClient

    interface SelfTestClient {
        createSession(
            profile: ConnectionProfile,
            control?: ClientRequestControl,
        ): Promise<string>;
        deleteSession(
            profile: ConnectionProfile,
            control?: ClientRequestControl,
        ): Promise<void>;
        listLayouts(
            profile: ConnectionProfile,
            control?: ClientRequestControl,
        ): Promise<string[]>;
        listScripts(
            profile: ConnectionProfile,
            control?: ClientRequestControl,
        ): Promise<string[]>;
        getRecord(
            profile: ConnectionProfile,
            layout: string,
            recordId: string,
            control?: ClientRequestControl,
        ): Promise<FileMakerRecord>;
        listRecords(
            profile: ConnectionProfile,
            layout: string,
            options?: {
                limit?: number;
                offset?: number;
                sort?: Record<string, unknown>[];
            },
            control?: ClientRequestControl,
        ): Promise<FindRecordsResult>;
        findRecords(
            profile: ConnectionProfile,
            layout: string,
            body: FindRecordsRequest,
            control?: ClientRequestControl,
        ): Promise<FindRecordsResult>;
        getLayoutMetadata(
            profile: ConnectionProfile,
            layout: string,
            control?: ClientRequestControl & { recordHistory?: boolean },
        ): Promise<Record<string, unknown>>;
        editRecord(
            profile: ConnectionProfile,
            layout: string,
            recordId: string,
            fieldDataPartial: Record<string, unknown>,
            control?: ClientRequestControl,
            options?: EditRecordOptions,
        ): Promise<EditRecordResult>;
        createRecord(
            profile: ConnectionProfile,
            layout: string,
            fieldData: Record<string, unknown>,
            control?: ClientRequestControl,
        ): Promise<EditRecordResult>;
        deleteRecord(
            profile: ConnectionProfile,
            layout: string,
            recordId: string,
            control?: ClientRequestControl,
        ): Promise<EditRecordResult>;
        runScript(
            profile: ConnectionProfile,
            request: RunScriptRequest,
            control?: ClientRequestControl,
        ): Promise<RunScriptResult>;
        getProductInfo(
            profile: ConnectionProfile,
            control?: ClientRequestControl,
        ): Promise<{ name?: string; version?: string }>;
        listHostedDatabases(
            profile: ConnectionProfile,
            control?: ClientRequestControl,
        ): Promise<string[] | undefined>;
        resetObservation(): void;
        observation(): SelfTestObservation;
        verifyLoggedOut(
            profile: ConnectionProfile,
            token: string,
            signal?: AbortSignal,
        ): Promise<void>;
        scrub(text: string): string;
    }

    Hierarchy

    • Pick<
          FMClient,
          | "getProductInfo"
          | "createSession"
          | "listHostedDatabases"
          | "listLayouts"
          | "listScripts"
          | "getLayoutMetadata"
          | "listRecords"
          | "findRecords"
          | "getRecord"
          | "createRecord"
          | "editRecord"
          | "deleteRecord"
          | "runScript"
          | "deleteSession",
      >
      • SelfTestClient
    Index
    • Parameters

      • profile: ConnectionProfile
      • layout: string
      • Optionalcontrol: ClientRequestControl & { recordHistory?: boolean }
        • OptionalrecordHistory?: boolean

          Ancillary presentation lookups omit user history; metrics still record them.

      Returns Promise<Record<string, unknown>>

    • Runs a FileMaker script the way the Claris Data API Guide documents it ("Run a script", https://help.claris.com/en/data-api-guide/content/run-a-script.html):

      GET /fmi/data//databases//layouts//script/