urls

(static) authentication(host, database, versionopt) → {String}

The authentication function generates a url for retrieving authentication tokens.

Source:

utilities/urls.utilities.js, line 146

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL to use when authenticating a FileMaker DAPI session.

(static) create(host, database, layout, versionopt) → {String}

The create function generates a url for creating a new record.

Source:

utilities/urls.utilities.js, line 6

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`layout`	`String`			The database layout to use.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL to use when creating records.

(static) databases(host, versionopt) → {String}

The databases function generates a url for retrieving FileMaker Server hosted databases.

Source:

utilities/urls.utilities.js, line 228

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

The URL to use to retrieve FileMaker Server hosted databases.

(static) delete(host, database, layout, recordId, versionopt) → {String}

The delete funtion generates a url for deleting a record.

Source:

utilities/urls.utilities.js, line 35

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`layout`	`String`			The database layout to use.
`recordId`	`String`			The FileMaker internal record id to update.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL to use when deleting records.

(static) duplicate(host, database, layout, recordId, versionopt) → {String}

The duplicate function generates a url for duplicating FileMaker records. in exchange for Account credentials.

Source:

utilities/urls.utilities.js, line 200

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`layout`	`String`			The database layout to use.
`recordId`	`String`			The FileMaker internal record id to duplicate.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL to duplicate FileMaker records.

(static) find(host, database, layout, versionopt) → {String}

The find function generates a url for performing a find request.

Source:

utilities/urls.utilities.js, line 79

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`layout`	`String`			The database layout to use.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL to use when performing a find.

(static) get(host, database, layout, recordId, versionopt) → {String}

The get function generates a url to get a record's details.

Source:

utilities/urls.utilities.js, line 50

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`layout`	`String`			The database layout to use.
`recordId`	`String`			The FileMaker internal record id to update.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL to used when getting one record.

(static) globals(host, database, versionopt) → {String}

The global function generates a url for setting globals. Like FileMaker globals, these values will only be set for the current session.

Source:

utilities/urls.utilities.js, line 93

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL to use when setting globals

(static) layout(host, database, layout, versionopt) → {String}

The layout function generates a url for getting specific layout metadata. in exchange for Account credentials.

Source:

utilities/urls.utilities.js, line 172

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`layout`	`String`			The database layout to use.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL for retrieving specific layout metadata.

(static) layouts(host, database, versionopt) → {String}

The layouts function generates a url for retrieving database layouts.

Source:

utilities/urls.utilities.js, line 159

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL for retrieving database layouts.

(static) list(host, database, layout, versionopt) → {String}

The list function generates a url for listing records.

Source:

utilities/urls.utilities.js, line 65

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`layout`	`String`			The database layout to use.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL to use when listing records.

(static) logout(host, database, token, versionopt) → {String}

The logout function generates a url for logging out of a FileMaker Session.

Source:

utilities/urls.utilities.js, line 107

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`token`	`String`			The token to logout
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL to use when logging out of a FileMaker DAPI session.

(static) productInfo(host, versionopt) → {String}

The productInfo function generates a url for retrieving FileMaker Server metadata.

Source:

utilities/urls.utilities.js, line 216

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

The URL to use to retrieve FileMaker Server metadata.

(static) script(host, database, layout, script, parameteropt, versionopt) → {String}

The script function generates a url for running a FileMaker script.

Source:

utilities/urls.utilities.js, line 240

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`layout`	`String`			The database layout to use.
`script`	`String`			The name of the script to run .
`parameter`	`String` \| `Object` \| `Number`	<optional>		Optional script parameters to pass to the called script.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

The URL to call a specific FileMaker script

(static) scripts(host, database, versionopt) → {String}

The scripts function generates a url for listing database scripts.

Source:

utilities/urls.utilities.js, line 187

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL for listing datbase scripts

(static) update(host, database, layout, recordId, versionopt) → {String}

The update function generates a url for updating a record.

Source:

utilities/urls.utilities.js, line 20

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`layout`	`String`			The database layout to use.
`recordId`	`String`			The FileMaker internal record id to update.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL to use when updating records.

(static) upload(host, database, layout, recordId, fieldName, fieldRepetitionopt, versionopt) → {String}

The upload function generates a url for use when uploading files to FileMaker containers.

Source:

utilities/urls.utilities.js, line 121

Parameters:

Name	Type	Attributes	Default	Description
`host`	`String`			The host FileMaker server.
`database`	`String`			The FileMaker database to target.
`layout`	`String`			The database layout to use.
`recordId`	`String`			the record id to use when inserting the file.
`fieldName`	`String`			the field to use when inserting a file.
`fieldRepetition`	`String` \| `Number`	<optional>	1	The field repetition to use when inserting the file. The default is 1.
`version`	`String`	<optional>	"vLatest"	The Data API version to use. The default is 'vLatest'.

Returns:

Type:: String

A URL to use when uploading files to FileMaker.

new urls()

Methods

(static) authentication(host, database, versionopt) → {String}

Parameters:

Returns:

(static) create(host, database, layout, versionopt) → {String}

Parameters:

Returns:

(static) databases(host, versionopt) → {String}

Parameters:

Returns:

(static) delete(host, database, layout, recordId, versionopt) → {String}

Parameters:

Returns:

(static) duplicate(host, database, layout, recordId, versionopt) → {String}

Parameters:

Returns:

(static) find(host, database, layout, versionopt) → {String}

Parameters:

Returns:

(static) get(host, database, layout, recordId, versionopt) → {String}

Parameters:

Returns:

(static) globals(host, database, versionopt) → {String}

Parameters:

Returns:

(static) layout(host, database, layout, versionopt) → {String}

Parameters:

Returns:

(static) layouts(host, database, versionopt) → {String}

Parameters:

Returns:

(static) list(host, database, layout, versionopt) → {String}

Parameters:

Returns:

(static) logout(host, database, token, versionopt) → {String}

Parameters:

Returns:

(static) productInfo(host, versionopt) → {String}

Parameters:

Returns:

(static) script(host, database, layout, script, parameteropt, versionopt) → {String}

Parameters:

Returns:

(static) scripts(host, database, versionopt) → {String}

Parameters:

Returns:

(static) update(host, database, layout, recordId, versionopt) → {String}

Parameters:

Returns:

(static) upload(host, database, layout, recordId, fieldName, fieldRepetitionopt, versionopt) → {String}

Parameters:

Returns: