FMDataMBS.Constructor

FMDataMBS.CreateRecord(request as FMRequestMBS) as FMResponseMBS

Please set layout property before calling this.

Some examples using this method:

• /CURL/FMAPI/FileMaker Data API Test

FMDataMBS.DatabaseNames as FMResponseMBS

Some examples using this method:

• /CURL/FMAPI/FileMaker Data API Test

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

Please set layout property before calling this.

Some examples using this method:

• /CURL/FMAPI/FileMaker Data API Test

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

Please set layout property before calling this.

Some examples using this method:

• /CURL/FMAPI/FileMaker Data API Test

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

Please set layout property before calling this.

Some examples using this method:

• /CURL/FMAPI/FileMaker Data API Test

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

Runs the script server side synchronously.
You can pass a script parameter.

The response contains the error code and/or the result of the script.

When using FileMaker Data API to run a script, make sure that the script has a unique name. If there are multiple scripts with the same name, FileMaker Data API cannot control which script is called, even if the scripts are in different folders.

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

var connection as FMDataMBS // your connection

// which layout to use
connection.Layout = LayoutMenu.Text

// see
// https://help.claris.com/en/data-api-guide/content/perform-find-request.html

Var request As New FMRequestMBS

// just query first 100 records
request.offset = 1
request.limit = 100

// e.g. [{"Name" : "=Test"}]
response = connection.FindRecords(request, queryField.Text.Trim)
´

Please set layout property before calling this.

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

see also FileMaker's documentation:
https://help.claris.com/en/data-api-guide/content/perform-find-request.html

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

Please set layout property before calling this.

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

Please set layout property before calling this.

Some examples using this method:

• /CURL/FMAPI/FileMaker Data API Test

FMDataMBS.LayoutMetadata(recordId as String) as FMResponseMBS

RecordID: Record ID to retrieve related value list data

Some examples using this method:

• /CURL/FMAPI/FileMaker Data API Test

FMDataMBS.LayoutNames as FMResponseMBS

Some examples using this method:

• /CURL/FMAPI/FileMaker Data API Test

FMDataMBS.Login as FMResponseMBS

Var d As New FMDataMBS

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

Var 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:

• Login(dataSources() as FMDataSourceMBS) as FMResponseMBS

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

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:

• Login as FMResponseMBS

FMDataMBS.Logout as FMResponseMBS

Clears session token property.

FMDataMBS.ProductInfo as FMResponseMBS

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

Some examples using this method:

• /CURL/FMAPI/FileMaker Data API Test

FMDataMBS.ScriptNames as FMResponseMBS

Some examples using this method:

• /CURL/FMAPI/FileMaker Data API Test

FMDataMBS.SetGlobalFields(globalFields as Dictionary) as FMResponseMBS

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:

• /CURL/FMAPI/FileMaker Data API Test

FMDataMBS.UploadToContainerField(Upload as FMContainerUploadMBS) as FMResponseMBS

upload: File to upload into container field

Some examples using this method:

• /CURL/FMAPI/FileMaker Data API Test

FMDataMBS.ValidateSession as FMResponseMBS