Platforms to show: All Mac Windows Linux Cross-Platform

Back to FMDataMBS class.

FMDataMBS.Constructor

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The constructor.

FMDataMBS.CreateRecord(request as FMRequestMBS) as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Create a new record.

Please set layout property before calling this.

Some examples using this method:

FMDataMBS.DatabaseNames as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Retrieve a list of hosted FileMaker databases.

Some examples using this method:

FMDataMBS.DeleteRecord(request as FMRequestMBS = nil, recordId as String) as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Delete a record by recordId.

Please set layout property before calling this.

Some examples using this method:

FMDataMBS.DuplicateRecord(request as FMRequestMBS = nil, recordId as String) as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Duplicate a record by recordId.

Please set layout property before calling this.

Some examples using this method:

FMDataMBS.EditRecord(request as FMRequestMBS = nil, recordId as String) as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Edit a record by recordId.

Please set layout property before calling this.

Some examples using this method:

FMDataMBS.ExecuteScript(scriptName as String, scriptParam as String = "") as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Execute Script.

FMDataMBS.FindRecords(request as FMRequestMBS = nil, query as String) as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Find Records in a Layout.

Please set layout property before calling this.

Query: JSON with Fields and Find criteria in the following query schema:
[ { "<fieldName>": "<fieldValue>", "omit" : "true" ... }, ...]

FMDataMBS.GetRecord(request as FMRequestMBS = nil, recordId as String) as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Get a record by recordId.

Please set layout property before calling this.

FMDataMBS.GetRecords(request as FMRequestMBS = nil) as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Get records.

Please set layout property before calling this.

Some examples using this method:

FMDataMBS.LayoutMetadata(recordId as String) as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Retrieves layout metadata for a FileMaker database.

RecordID: Record ID to retrieve related value list data

Some examples using this method:

FMDataMBS.LayoutNames as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Retrieves a list of layouts for a FileMaker database.

Some examples using this method:

FMDataMBS.Login as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Login to a FileMaker database.
Example
Dim d As New FMDataMBS

d.Password = "admin"
d.Username = "admin"
d.Server = "localhost"
d.Database = "test"

Dim r As FMResponseMBS = d.Login

If r = Nil Then
msgbox "Failed?"
else
MsgBox r.ErrorMessage
End If

Please either set UserName and Password or OAuthRequestId and OAuthIdentifier.
If you don't call Login explicitly or the session token expired, the plugin will call it for you.

See also:

FMDataMBS.Login(dataSources() as FMDataSourceMBS) as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Login to a FileMaker database.

Please either set UserName and Password or OAuthRequestId and OAuthIdentifier.

dataSources: External FileMaker Data Source Authentication.

Clears session token property.
If you don't call Login explicitly or the session token expired, the plugin will call it for you.

See also:

FMDataMBS.Logout as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Log out of a FileMaker database.

Clears session token property.

FMDataMBS.ProductInfo as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Retrieves information about the Claris FileMaker Server or Claris FileMaker Cloud host.

Result property in FMResponseMBS is a dictionary with entries including buildDate, name, version, dateFormat, timeFormat and timeStampFormat.

Some examples using this method:

FMDataMBS.ScriptNames as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Retrieves a list of scripts for a FileMaker database.

Some examples using this method:

FMDataMBS.SetGlobalFields(globalFields as Dictionary) as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Set Global Fields.

globalFields: A dictionary that contains field-value pairs to set global fields in a target database. Field names must be Fully Qualified.

Some examples using this method:

FMDataMBS.UploadToContainerField(Upload as FMContainerUploadMBS) as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Upload a single file into a container field.

upload: File to upload into container field

Some examples using this method:

FMDataMBS.ValidateSession as FMResponseMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
method Claris FileMaker Data API MBS FMAPI Plugin 20.4 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
Validate session token.

The items on this page are in the following plugins: MBS FMAPI Plugin.


The biggest plugin in space...