FMRequestMBS.FieldData as Dictionary

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

A dictionary that contains field-value pairs for fields in the target layout.

If empty dictionary is provided as a data value, an empty record is created with any auto enter values defined in the current table’s schema.
(Read and Write property)

Some examples using this property:

• /FMAPI/FileMaker Data API Test

FMRequestMBS.layoutResponse as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The layout to switch to when processing response.

(Read and Write property)

FMRequestMBS.limit as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The maximum number of records that should be returned. If not specified, the default value is 100.

Default value is -1 for the plugin to not specify it in the request.
(Read and Write property)

FMRequestMBS.ModId as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The last modification ID.

When you use modId, a record is edited only when the modId matches.
Only for editing records.
(Read and Write property)

FMRequestMBS.offset as Integer

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The record number of the first record in the range of records.

Default value is -1 for the plugin to not specify it in the request.
(Read and Write property)

FMRequestMBS.PortalData as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

A JSON object that contains portal row values in the target layout.

The format mirrors the portalData format from Get Records.
(Read and Write property)

Some examples using this property:

• /FMAPI/FileMaker Data API Test

FMRequestMBS.scriptName as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The name of the FileMaker script to be run after the action specified by the API call and after the subsequent sort.

Pass parameter via scriptParam property.
(Read and Write property)

Some examples using this property:

• /FMAPI/FileMaker Data API Test

FMRequestMBS.scriptParam as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

A parameter for the FileMaker script named by scriptName.

(Read and Write property)

FMRequestMBS.scriptPrerequestName as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The name of the FileMaker script to be run before the action specified by the API call and the subsequent sort.

Pass parameter via scriptPrerequestParam property.
(Read and Write property)

FMRequestMBS.scriptPrerequestParam as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

A parameter for the FileMaker script named by script.prerequest.

(Read and Write property)

FMRequestMBS.scriptPresortName as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

The name of the FileMaker script to be run after the action specified by the API call but before the subsequent sort.

Pass parameter via scriptPresortParam property.
(Read and Write property)

FMRequestMBS.scriptPresortParam as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

A parameter for the FileMaker script named by scriptPresortName.

(Read and Write property)

FMRequestMBS.sort as String

Type	Topic	Plugin	Version	macOS	Windows	Linux	iOS	Targets
property	Claris FileMaker Data API	MBS FMAPI Plugin	20.4	✅ Yes	✅ Yes	✅ Yes	✅ Yes	All

Field name and sort order of the result set.

The order in which the criteria are specified determines the precedence. Records are returned in the original creation order if a sort order is not provided. The default sort order is "ascend".
A JSON value, e.g.:
[ { "fieldName": "LastName", "sortOrder": "ascend" }, { "fieldName": "FirstName", "sortOrder": "ascend" } ]
(Read and Write property)