Monkeybread Software - MBS FileMaker Plugin: CURL FMS Admin API v18

Components	All	New	MacOS		Windows		Linux		iOS
Examples	Mac & Win		Server	Client	Guides	Statistic	FMM	Blog	Deprecated	Old

MBS FileMaker Plugin Example Databases

CURL FMS Admin API v18

All examples are included with download of MBS FileMaker Plugin.

CURL FMS Admin API v18.fmp12

Overview
Tables	1
Relationships	0
Layouts	1
Scripts	17
Value Lists	0
Custom Functions	0
Custom Menus	33

File Options
Default custom menu set	[Standard FileMaker Menus]
When opening file
Minimum allowed version	12.0
Login using	Account Name; Account= Admin
Allow user to save password	Off
Require iOS passcode	Off
Switch to layout	Off
Hide all toolbars	Off
Script triggers
OnFirstWindowOpen	Off
OnLastWindowClose	Off
OnWindowOpen	Off
OnWindowClose	Off
OnFileAVPlayerChange	Off
Thumbnail Settings
Generate Thumbnails	On; Temporary

Tables

Table Name	Statistics	Occurrences in Relationship Graph
AdminAPI	9 fields defined, 2 records	AdminAPI

Fields

Table Name: AdminAPI - 9 Fields
Field Name	Type	Options	Comments	On Layouts	In Relationships	In Scripts	In Value Lists
Result	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		AdminAPI		Login Logout Get Server Status Start Server Stop Server Get Server General Configuration Get Server Security Configuration List Databases List Schedules Get Server PHP Configuration Enable PHP Disable PHP Get DATA API Configuration ODATA Settings Send Message to client Disconnect Client Clear
Text	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		AdminAPI		Login Logout Get Server Status Start Server Stop Server Get Server General Configuration Get Server Security Configuration List Databases List Schedules Get Server PHP Configuration Enable PHP Disable PHP Get DATA API Configuration ODATA Settings Send Message to client Disconnect Client Clear
debug	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		AdminAPI		Login Logout Get Server Status Start Server Stop Server Get Server General Configuration Get Server Security Configuration List Databases List Schedules Get Server PHP Configuration Enable PHP Disable PHP Get DATA API Configuration ODATA Settings Send Message to client Disconnect Client Clear
URL	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German
Server	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Global Repetitions: 1 Index Language: German		AdminAPI		Login Logout Get Server Status Start Server Stop Server Get Server General Configuration Get Server Security Configuration List Databases List Schedules Get Server PHP Configuration Enable PHP Disable PHP Get DATA API Configuration ODATA Settings Send Message to client Disconnect Client
Username	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Global Repetitions: 1 Index Language: German		AdminAPI		Login
Password	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Global Repetitions: 1 Index Language: German		AdminAPI		Login
Session	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Global Repetitions: 1 Index Language: German		AdminAPI		Login Logout Get Server Status Start Server Stop Server Get Server General Configuration Get Server Security Configuration List Databases List Schedules Get Server PHP Configuration Enable PHP Disable PHP Get DATA API Configuration ODATA Settings Send Message to client Disconnect Client Clear
HTTP Response	Normal, Text	Auto-Enter: Allow editing Validation: Only during data entry Storage: Repetitions: 1 Indexing: None Automatically create indexes as needed Index Language: German		AdminAPI		Login Logout Get Server Status Start Server Stop Server Get Server General Configuration Get Server Security Configuration List Databases List Schedules Get Server PHP Configuration Enable PHP Disable PHP Get DATA API Configuration ODATA Settings Send Message to client Disconnect Client

Layout Objects: AdminAPI

Regular Fields

Field Name: AdminAPI::Result

Layout Name:

AdminAPI

Top: 84 pt
Left: 53 pt
Bottom: 103 pt
Right: 306 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Yes

Field Name: AdminAPI::Text

Layout Name:

AdminAPI

Top: 108 pt
Left: 53 pt
Bottom: 564 pt
Right: 386 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Yes

Field Name: AdminAPI::debug

Layout Name:

AdminAPI

Top: 91 pt
Left: 450 pt
Bottom: 564 pt
Right: 763 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: System Default
Go to next field using: Tab key

Yes

Field Name: AdminAPI::Server

Layout Name:

AdminAPI

Top: 7 pt
Left: 64 pt
Bottom: 26 pt
Right: 317 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: Default for Data Type
Go to next field using: Tab key

Field Name: AdminAPI::Username

Layout Name:

AdminAPI

Top: 9 pt
Left: 404 pt
Bottom: 28 pt
Right: 657 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: Default for Data Type
Go to next field using: Tab key

Field Name: AdminAPI::Password

Layout Name:

AdminAPI

Top: 35 pt
Left: 404 pt
Bottom: 54 pt
Right: 657 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: Default for Data Type
Go to next field using: Tab key

Field Name: AdminAPI::Session

Layout Name:

AdminAPI

Top: 584 pt
Left: 133 pt
Bottom: 603 pt
Right: 386 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: Default for Data Type
Go to next field using: Tab key

Field Name: AdminAPI::HTTP Response

Layout Name:

AdminAPI

Top: 84 pt
Left: 317 pt
Bottom: 103 pt
Right: 386 pt

Anchoring: Left, Top

Field Format:

Edit Box

Field Behavior:

Allow field to be entered: In Find mode, In Browse mode
Touch keyboard type: Default for Data Type
Go to next field using: Tab key

Type:

Text: Login

Layout Name:

AdminAPI

Top: 78 pt
Left: 775 pt
Bottom: 103 pt
Right: 915 pt

Anchoring: Left, Top

Perform Script [ “Login” ]

Scripts:

Button Properties

Coordinates

Script/Script Step

Type:

Text: Logout

Layout Name:

AdminAPI

Top: 108 pt
Left: 775 pt
Bottom: 133 pt
Right: 915 pt

Anchoring: Left, Top

Perform Script [ “Logout” ]

Scripts:

Logout

Button Properties

Coordinates

Script/Script Step

Type:

Text: Get Server Status

Layout Name:

AdminAPI

Top: 138 pt
Left: 775 pt
Bottom: 163 pt
Right: 915 pt

Anchoring: Left, Top

Perform Script [ “Get Server Status” ]

Scripts:

Get Server Status

Button Properties

Coordinates

Script/Script Step

Type:

Text: Start Server

Layout Name:

AdminAPI

Top: 168 pt
Left: 775 pt
Bottom: 193 pt
Right: 915 pt

Anchoring: Left, Top

Perform Script [ “Start Server” ]

Scripts:

Start Server

Button Properties

Coordinates

Script/Script Step

Type:

Text: Stop Server

Layout Name:

AdminAPI

Top: 198 pt
Left: 775 pt
Bottom: 223 pt
Right: 915 pt

Anchoring: Left, Top

Perform Script [ “Stop Server” ]

Scripts:

Stop Server

Button Properties

Coordinates

Script/Script Step

Type:

Text: Get General Config

Layout Name:

AdminAPI

Top: 228 pt
Left: 775 pt
Bottom: 253 pt
Right: 915 pt

Anchoring: Left, Top

Perform Script [ “Get Server General Configuration” ]

Scripts:

Get Server General Configuration

Button Properties

Coordinates

Script/Script Step

Type:

Text: Get Security Config

Layout Name:

AdminAPI

Top: 258 pt
Left: 775 pt
Bottom: 283 pt
Right: 915 pt

Anchoring: Left, Top

Perform Script [ “Get Server Security Configuration” ]

Scripts:

Get Server Security Configuration

Button Properties

Coordinates

Script/Script Step

Type:

Text: List Databases

Layout Name:

AdminAPI

Top: 288 pt
Left: 775 pt
Bottom: 313 pt
Right: 915 pt

Anchoring: Left, Top

Perform Script [ “List Databases” ]

Scripts:

List Databases

Button Properties

Coordinates

Script/Script Step

Type:

Text: List Schedules

Layout Name:

AdminAPI

Top: 318 pt
Left: 775 pt
Bottom: 343 pt
Right: 915 pt

Anchoring: Left, Top

Perform Script [ “List Schedules” ]

Scripts:

List Schedules

Button Properties

Coordinates

Script/Script Step

Type:

Text: Get PHP Config

Layout Name:

AdminAPI

Top: 348 pt
Left: 775 pt
Bottom: 373 pt
Right: 915 pt

Anchoring: Left, Top

Perform Script [ “Get Server PHP Configuration” ]

Scripts:

Get Server PHP Configuration

Button Properties

Coordinates

Script/Script Step

Type:

Text: Open Documentation

Layout Name:

AdminAPI

Top: 32 pt
Left: 17 pt
Bottom: 57 pt
Right: 157 pt

Anchoring: Left, Top

Open URL [ "https://" & AdminAPI::Server & "/fmi/admin/apidoc/" ] [ No dialog ]

Fields:

AdminAPI::Server

Script Hierarchy

Script Name	Clear
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	Set Field [ AdminAPI::Result; "" ] Set Field [ AdminAPI::Text; "" ] Set Field [ AdminAPI::Session; "" ] Set Field [ AdminAPI::debug; "" ]
Fields used in this script	AdminAPI::Result AdminAPI::Text AdminAPI::Session AdminAPI::debug
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Authentication

Parent Folder: [Authentication]

Next Script: [Logout]

Script Name	Login
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	AdminAPI
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/user/auth") ] Set Variable [ $result; Value:MBS("CURL.SetOptionUserName"; $curl; AdminAPI::Username) ] Set Variable [ $result; Value:MBS("CURL.SetOptionPassword"; $curl; AdminAPI::Password) ] Set Variable [ $result; Value:MBS("CURL.SetOptionConnectionTimeout"; $curl; 10) ] Set Variable [ $result; Value:MBS("CURL.SetOptionPost"; $curl; 1) ] Set Variable [ $result; Value:MBS("CURL.SetOptionPostFields"; $curl; " ") // newer version needs POST with length ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] If [ (AdminAPI::Result = "OK") and ($responseCode = 200) ] Set Field [ AdminAPI::Session; MBS( "JSON.GetPathItem"; AdminAPI::Text; "response¶token"; 1) ] End If #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Username AdminAPI::Password AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response AdminAPI::Session
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Login]

Parent Folder: [Authentication]

Script Name	Logout
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	AdminAPI
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/user/auth/" & AdminAPI::Session) ] Set Variable [ $result; Value:MBS("CURL.SetOptionCustomRequest"; $curl; "DELETE") ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Field [ AdminAPI::Session; "" ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Database Server

Parent Folder: [Database Server]

Next Script: [Start Server]

Script Name	Get Server Status
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	AdminAPI
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/server/status") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session) ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Get Server Status]

Parent Folder: [Database Server]

Next Script: [Stop Server]

Script Name	Start Server
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	AdminAPI
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] #Set URL to load (HTTP, HTTPS, FTP, FTPS, SFTP, etc.) Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/server/status") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session; "Content-Type: application/json") ] Set Variable [ $result; Value:MBS("CURL.SetInputText"; $curl; "{\"status\": \"RUNNING\"}"; "UTF-8") ] Set Variable [ $result; Value:MBS("CURL.SetOptionUpload"; $curl; 1) ] Set Variable [ $result; Value:MBS("CURL.SetOptionCustomRequest"; $curl; "PATCH") ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Start Server]

Parent Folder: [Database Server]

Next Script: [Get Server General Configuration]

Script Name	Stop Server
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	AdminAPI
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] #Set URL to load (HTTP, HTTPS, FTP, FTPS, SFTP, etc.) Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/server/status") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session; "Content-Type: application/json") ] Set Variable [ $result; Value:MBS("CURL.SetInputText"; $curl; "{\"status\": \"STOPPED\"}"; "UTF-8") ] Set Variable [ $result; Value:MBS("CURL.SetOptionUpload"; $curl; 1) ] Set Variable [ $result; Value:MBS("CURL.SetOptionCustomRequest"; $curl; "PATCH") ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Stop Server]

Parent Folder: [Database Server]

Next Script: [Get Server Security Configuration]

Script Name	Get Server General Configuration
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	AdminAPI
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] #Set URL to load (HTTP, HTTPS, FTP, FTPS, SFTP, etc.) Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/server/config/general") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session) ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Get Server General Configuration]

Parent Folder: [Database Server]

Script Name	Get Server Security Configuration
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	AdminAPI
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] #Set URL to load (HTTP, HTTPS, FTP, FTPS, SFTP, etc.) Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/server/config/security") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session) ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Databases

Parent Folder: [Databases]

Script Name	List Databases
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	AdminAPI
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/databases") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session) ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Schedules

Parent Folder: [Schedules]

Script Name	List Schedules
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	AdminAPI
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/schedules") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session) ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

PHP

Parent Folder: [PHP]

Next Script: [Enable PHP]

Script Name	Get Server PHP Configuration
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script	AdminAPI
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] #Set URL to load (HTTP, HTTPS, FTP, FTPS, SFTP, etc.) Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/php/config") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session) ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Get Server PHP Configuration]

Parent Folder: [PHP]

Next Script: [Disable PHP]

Script Name	Enable PHP
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] #Set URL to load (HTTP, HTTPS, FTP, FTPS, SFTP, etc.) Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/php/config") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session; "Content-Type: application/json") ] Set Variable [ $result; Value:MBS("CURL.SetInputText"; $curl; "{\"enabled\": true}"; "UTF-8") ] Set Variable [ $result; Value:MBS("CURL.SetOptionUpload"; $curl; 1) ] Set Variable [ $result; Value:MBS("CURL.SetOptionCustomRequest"; $curl; "PATCH") ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Enable PHP]

Parent Folder: [PHP]

Script Name	Disable PHP
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] #Set URL to load (HTTP, HTTPS, FTP, FTPS, SFTP, etc.) Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/php/config") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session; "Content-Type: application/json") ] Set Variable [ $result; Value:MBS("CURL.SetInputText"; $curl; "{\"enabled\": false}"; "UTF-8") ] Set Variable [ $result; Value:MBS("CURL.SetOptionUpload"; $curl; 1) ] Set Variable [ $result; Value:MBS("CURL.SetOptionCustomRequest"; $curl; "PATCH") ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

DATA API

Parent Folder: [DATA API]

Next Script: [ODATA Settings]

Script Name	Get DATA API Configuration
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/fmdapi/config") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session) ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Get DATA API Configuration]

Parent Folder: [DATA API]

Script Name	ODATA Settings
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	#Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/fmodata/config") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session) ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Clients

Parent Folder: [Clients]

Next Script: [Disconnect Client]

Script Name	Send Message to client
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	#Get client ID from Database List Set Variable [ $clientID; Value:8 ] #Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/clients/" & $clientID ) ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session; "Content-Type: application/json") ] Set Variable [ $json; Value:MBS( "JSON.AddStringToObject"; "{}"; "messageText"; "Hello World" ) ] Set Variable [ $result; Value:MBS("CURL.SetOptionPostFields"; $curl; $json) ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Previous Script: [Send Message to client]

Parent Folder: [Clients]

Script Name	Disconnect Client
Run script with full access privileges	Off
Include In Menu	Yes
Layouts that use this script
Scripts that use this script
Script Definition
Script Steps	#Get client ID from Database List Set Variable [ $clientID; Value:8 ] #Start new session Set Variable [ $curl; Value:MBS("CURL.New") ] Set Variable [ $message; Value:"Good bye!" ] Set Variable [ $result; Value:MBS("CURL.SetOptionURL"; $curl; "https://" & AdminAPI::Server & "/fmi/admin/api/v2/clients/" & $clientID & "?messageText=" & MBS( "Text.EncodeURLComponent"; $message; "UTF-8" ) & "&graceTime=30") ] Set Variable [ $result; Value:MBS("CURL.SetOptionHTTPHeader"; $curl; "Expect: "; "Authorization: Bearer " & AdminAPI::Session; "Content-Type: application/json") ] Set Variable [ $result; Value:MBS("CURL.SetOptionCustomRequest"; $curl; "DELETE") ] Set Variable [ $result; Value:MBS("CURL.SetOptionPut"; $curl; 1) ] #RUN now Set Field [ AdminAPI::Result; MBS("CURL.Perform"; $curl) ] #Check result Set Field [ AdminAPI::Text; MBS("CURL.GetResultAsText"; $curl; "UTF8") ] Set Field [ AdminAPI::debug; MBS("CURL.GetDebugMessages"; $curl) ] Set Variable [ $responseCode; Value:MBS( "CURL.GetResponseCode"; $curl ) ] Set Field [ AdminAPI::HTTP Response; $responseCode ] #Cleanup Set Variable [ $result; Value:MBS("CURL.Cleanup"; $curl) ]
Fields used in this script	AdminAPI::Server AdminAPI::Session AdminAPI::Result AdminAPI::Text AdminAPI::debug AdminAPI::HTTP Response
Scripts used in this script
Layouts used in this script
Tables used in this script	AdminAPI
Table occurrences used by this script	AdminAPI
Custom Functions used by this script
Custom menu set used by this script

Download example: CURL FMS Admin API v18

Used functions: