Claris FileMaker Cloud Admin API
FileMaker Admin API は Admin Console ではなくスクリプトを使用することで FileMaker Cloud および FileMaker Server 上での管理タスクを Web サービスから実行できるようにするアプリケーションプログラミングインターフェース (API) です。この API は REST (Representational State Transfer) アーキテクチャを使用しているため、Admin API は REST API です。
アクション
アクション |
構成フィールド |
データタイプ |
必須 |
---|---|---|---|
Create FileMaker script schedule - FileMaker スクリプトスケジュールを作成します。 |
Timeout - スクリプトの実行を許可する分単位の時間制限。タイムアウトが「0」の場合は時間制限がないことを意味します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「2」が使用されます。 |
String |
|
Days of the week - スケジュールを実行する各曜日の短縮形。可能な値: 「SUN」、「MON」、「TUE」、「WED」、「THU」、「FRI」、および 「SAT」。 |
|
|
|
Daily end date - 日次スケジュールの終了日。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
End date - 日次スケジュールの終了日。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Daily start time - 日次スケジュールの開始日時。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Send email - 通知の送信先の電子メールアドレス。値が空の場合は電子メールの送信が無効になります。メモ: 電子メールを送信するには SMTP を構成する必要があります。 |
|
|
|
Resource - FileMaker データベース名。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
FileMaker script account - FileMaker データベーススクリプトのアカウント名。 |
String |
|
|
FileMaker script name - FileMaker データベーススクリプト名。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
FileMaker script param - FileMaker データベーススクリプトの引数。 |
String |
|
|
FileMaker script password - FileMaker データベーススクリプトのパスワード。 |
String |
|
|
Daily days - スケジュールを実行する日の間隔。たとえば、値が 3 の場合はスケジュールが 3 日ごとに繰り返されます。この引数を指定せずにスケジュールを作成すると、デフォルト値の「1」が使用されます。 |
String |
|
|
Schedule name - スケジュールの名前。空の文字列または空白の文字列にすることはできません。 |
String |
|
|
Daily repeat frequency - 1 日にスケジュールを繰り返す回数。[Daily repeat interval] が分単位である場合は値が 1 から 60 までの整数である必要があります。[Daily repeat interval] が時間単位である場合は値が 1 から 24 までの整数である必要があります。 |
String |
|
|
Weekly repeat frequency - 1 週間にスケジュールを繰り返す回数。[Repeat interval] が分単位である場合は値が 1 から 60 までの整数である必要があります。[Repeat interval] が時間単位である場合は値が 1 から 24 までの整数である必要があります。 |
String |
|
|
End date - スケジュールの終了日。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Start timestamp - スケジュールの開始日時。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Daily repeat interval - スケジュールを繰り返す時間間隔。「MINUTES」または「HOURS」を入力します。 |
String |
|
|
Weekly repeat interval - スケジュールを繰り返す時間間隔。「MINUTES」または「HOURS」を入力します。 |
String |
|
|
Weekly end date - 週次スケジュールの終了日時。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Weekly start timestamp - 週次スケジュールの開始日時。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Auto abort - 制限時間に達するか FileMaker Server が停止した場合にスケジュールを中止するかどうかを指定します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「false」が使用されます。 |
Boolean |
|
|
Enabled - スケジュールの実行を有効にするか、またはスケジュールの実行が有効になっているかを確認するかどうかを指定します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「false」が使用されます。 |
Boolean |
|
|
Edit/Run schedule - スケジュールを編集/実行します。 |
Schedule ID - スケジュールの ID。スケジュール ID 1 は FileMaker Server によって予約されています。 |
String |
|
FileMaker script sequence schedule timeout - スクリプトの実行を許可する分単位の時間制限。タイムアウトが「0」の場合は時間制限がないことを意味します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「2」が使用されます。 |
String |
|
|
FileMaker script schedule timeout - スクリプトの実行を許可する分単位の時間制限。タイムアウトが「0」の場合は時間制限がないことを意味します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「2」が使用されます。 |
String |
|
|
System script schedule timeout - スクリプトの実行を許可する分単位の時間制限。タイムアウトが「0」の場合は時間制限がないことを意味します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「2」が使用されます。 |
String |
|
|
Backup schedule resource type - バックアップスケジュールのリソースタイプを選択します。 |
Choice |
|
|
Message resource type - メッセージのリソースタイプを選択します。 |
Choice |
|
|
Verify schedule resource type - 検証スケジュールのリソースタイプを選択します。 |
Choice |
|
|
Backup schedule resource - FileMaker データベースフォルダのパス (DB_IN_FOLDER) または FileMaker データベース名 (SINGLE_DB)。リソースタイプが DB_IN_FOLDER または SINGLE_DB である場合にのみ許可され、その場合は必須です。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
Message schedule resource - FileMaker データベースフォルダのパス (DB_IN_FOLDER) または FileMaker データベース名 (SINGLE_DB)。リソースタイプが DB_IN_FOLDER または SINGLE_DB である場合にのみ許可され、その場合は必須です。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
Days of the week - スケジュールを実行する各曜日の短縮形。可能な値: 「SUN」、「MON」、「TUE」、「WED」、「THU」、「FRI」、および 「SAT」。 |
|
|
|
Backup schedule target - バックアップフォルダのパス。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
Daily end date - 日次スケジュールの終了日。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
End date - 日次スケジュールの終了日。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Daily start time - 日次スケジュールの開始日時。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Send email - 通知の送信先の電子メールアドレス。値が空の場合は電子メールの送信が無効になります。メモ: 電子メールを送信するには SMTP を構成する必要があります。 |
|
|
|
Verify schedule resource - FileMaker データベースフォルダのパス (DB_IN_FOLDER) または FileMaker データベース名 (SINGLE_DB)。リソースタイプが DB_IN_FOLDER または SINGLE_DB である場合にのみ許可され、その場合は必須です。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
FileMaker script schedule resource - FileMaker データベース名。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
FileMaker script sequence schedule resource - FileMaker データベース名。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
FileMaker script schdeule account - FileMaker データベーススクリプトのアカウント名。 |
String |
|
|
FileMaker script sequence schedule account - FileMaker データベーススクリプトのアカウント名。 |
String |
|
|
FileMaker script schedule name - FileMaker データベーススクリプト名。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
FileMaker script sequence schedule name - FileMaker データベーススクリプト名。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
FileMaker script schedule parameter - FileMaker データベーススクリプトの引数。 |
String |
|
|
FileMaker script sequence schedule parameter - FileMaker データベーススクリプトの引数。 |
String |
|
|
FileMaker script schedule password - FileMaker データベーススクリプトのパスワード。 |
String |
|
|
FileMaker script sequence schedule password - FileMaker データベーススクリプトのパスワード。 |
String |
|
|
Daily days - スケジュールを実行する日の間隔。たとえば、値が 3 の場合はスケジュールが 3 日ごとに繰り返されます。この引数を指定せずにスケジュールを作成すると、デフォルト値の「1」が使用されます。 |
String |
|
|
Max backups - 保持するバックアップの最大数。この引数を指定せずにスケジュールを作成すると、デフォルト値の「1」が使用されます。 |
String |
|
|
FileMaker script sequence schedule OS script post-processing - 後処理システムスクリプトの名前および完全パス。「osScript」または「osScript2」を指定する必要があり、それらのうちの少なくとも 1 つを指定する必要があります。 |
String |
|
|
FileMaker script sequence schedule OS script - 前処理システムスクリプトの名前および完全パス。「osScript」または「osScript2」を指定する必要があり、それらのうちの少なくとも 1 つを指定する必要があります。 |
String |
|
|
System script schedule OS script - システムスクリプトの名前および完全パス。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
Schedule name - スケジュールの名前。空の文字列または空白の文字列にすることはできません。 |
String |
|
|
Verify schedule time delay - データベースを閉じるまでの遅延分数。この引数を指定せずにスケジュールを作成すると、デフォルト値の「2」が使用されます。 |
String |
|
|
Daily repeat frequency - 1 日にスケジュールを繰り返す回数。[Daily repeat interval] が分単位である場合は値が 1 から 60 までの整数である必要があります。[Daily repeat interval] が時間単位である場合は値が 1 から 24 までの整数である必要があります。 |
String |
|
|
Weekly repeat frequency - 1 週間にスケジュールを繰り返す回数。[Repeat interval] が分単位である場合は値が 1 から 60 までの整数である必要があります。[Repeat interval] が時間単位である場合は値が 1 から 24 までの整数である必要があります。 |
String |
|
|
FileMaker script sequence schedule OS script parameter - 前処理システムスクリプトの引数。 |
String |
|
|
FileMaker script sequence schedule OS script post-processing parameter - 後処理システムスクリプトの引数。 |
String |
|
|
End date - スケジュールの終了日。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Start timestamp - スケジュールの開始日時。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Schedule status - スケジュールの状態。スケジュールを実行するには値を 「RUNNING」 に設定します。 |
String |
|
|
Message schedule text - クライアントに送信するテキストメッセージ。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
Verify schedule message text - クライアントに送信するテキストメッセージ。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
Daily repeat interval - スケジュールを繰り返す時間間隔。「MINUTES」または「HOURS」を入力します。 |
String |
|
|
Weekly repeat interval - スケジュールを繰り返す時間間隔。「MINUTES」または「HOURS」を入力します。 |
String |
|
|
FileMaker script sequence schedule OS script account - ユーザアカウント名。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
System script schedule OS script account - ユーザアカウント名。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
FileMaker script sequence schedule OS script password - ユーザアカウントパスワード。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
System script schedule OS script password - ユーザアカウントパスワード。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
Weekly end date - 週次スケジュールの終了日時。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Weekly start timestamp - 週次スケジュールの開始日時。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
FileMaker script schedule auto abort - 制限時間に達するか FileMaker Server が停止した場合にスケジュールを中止するかどうかを指定します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「false」が使用されます。 |
Boolean |
|
|
FileMaker script sequence schedule auto abort - 制限時間に達するか FileMaker Server が停止した場合にスケジュールを中止するかどうかを指定します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「false」が使用されます。 |
Boolean |
|
|
System script schedule auto abort - 制限時間に達するか FileMaker Server が停止した場合にスケジュールを中止するかどうかを指定します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「false」が使用されます。 |
Boolean |
|
|
Clone backup - バックアップファイルのクローンを作成するかどうかを指定します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「false」が使用されます。 |
Boolean |
|
|
Enabled - スケジュールの実行を有効にするか、またはスケジュールの実行が有効になっているかを確認するかどうかを指定します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「false」が使用されます。 |
Boolean |
|
|
Verify backup - 一貫性チェックを実行するかどうかを指定します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「false」が使用されます。メモ: このオプションを有効にすると、バックアップファイルのエラーを検出することができます。ただし、このオプションを有効にしてバックアップ操作を実行すると完了までに時間がかかり、マスタマシンでの他のアクティビティの速度が遅くなることがあります。 |
Boolean |
|
|
Change database status - ホスト上のデータベースの状態を変更します。 |
Database ID - データベースの ID を入力します。 |
String |
|
Save Key - 暗号化パスワードの保存をホストに許可します。状態が OPENED の場合にのみ許可されます。 |
Boolean |
|
|
Status - 状態を選択します。 |
Choice |
|
|
Force - データベースを強制的に閉じて接続されているクライアントの接続を解除します。graceTime オプションを上書きします。状態が CLOSED の場合にのみ許可されます。 |
Boolean |
|
|
Key - 暗号化されたデータベースを開くために必要なパスワード。状態が OPENED の場合にのみ必須で許可されます。メモ: FileMaker Admin API では暗号化キーは検証されません。無効なキーを入力した場合でもエラーコード 0 を受け取ります。 |
String |
|
|
Text message - 接続が解除されるクライアントに送信するテキストメッセージ。状態が CLOSED の場合にのみ必須で許可されます。 |
String |
|
|
Create message schedule - メッセージスケジュールを作成します。 |
Resource type - リソースタイプを選択します。 |
Choice |
|
Days of the week - スケジュールを実行する各曜日の短縮形。可能な値: 「SUN」、「MON」、「TUE」、「WED」、「THU」、「FRI」、および 「SAT」。 |
|
|
|
Daily end date - 日次スケジュールの終了日。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
End date - 日次スケジュールの終了日。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Daily start time - 日次スケジュールの開始日時。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Send email - 通知の送信先の電子メールアドレス。値が空の場合は電子メールの送信が無効になります。メモ: 電子メールを送信するには SMTP を構成する必要があります。 |
|
|
|
Resource - FileMaker データベースフォルダのパス (resourceType が DB_IN_FOLDER の場合) または FileMaker データベース名 (resourceType が SINGLE_DB の場合)。resourceType が DB_IN_FOLDER または SINGLE_DB である場合にのみ許可され、その場合は必須です。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
Daily days - スケジュールを実行する日の間隔。たとえば、値が 3 の場合はスケジュールが 3 日ごとに繰り返されます。この引数を指定せずにスケジュールを作成すると、デフォルト値の「1」が使用されます。 |
String |
|
|
Schedule name - スケジュールの名前。空の文字列または空白の文字列にすることはできません。 |
String |
|
|
Daily repeat frequency - 1 日にスケジュールを繰り返す回数。[Daily repeat interval] が分単位である場合は値が 1 から 60 までの整数である必要があります。[Daily repeat interval] が時間単位である場合は値が 1 から 24 までの整数である必要があります。 |
String |
|
|
Weekly repeat frequency - 1 週間にスケジュールを繰り返す回数。[Repeat interval] が分単位である場合は値が 1 から 60 までの整数である必要があります。[Repeat interval] が時間単位である場合は値が 1 から 24 までの整数である必要があります。 |
String |
|
|
End date - スケジュールの終了日。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Start timestamp - スケジュールの開始日時。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Message text - クライアントに送信するテキストメッセージ。この引数を空の文字列または空白の文字列にすることはできません。 |
String |
|
|
Daily repeat interval - スケジュールを繰り返す時間間隔。「MINUTES」または「HOURS」を入力します。 |
String |
|
|
Weekly repeat interval - スケジュールを繰り返す時間間隔。「MINUTES」または「HOURS」を入力します。 |
String |
|
|
Weekly end date - 週次スケジュールの終了日時。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Weekly start timestamp - 週次スケジュールの開始日時。24 時間形式 (yyyy-mm-ddThh:mm:ss) で入力します。 |
String |
|
|
Enabled - スケジュールの実行を有効にするか、またはスケジュールの実行が有効になっているかを確認するかどうかを指定します。この引数を指定せずにスケジュールを作成すると、デフォルト値の「false」が使用されます。 |
Boolean |
|
|
Change status of all databases - ホスト上のすべてのデータベースの状態を変更します。 |
Status - 状態を選択します。 |
Choice |
|
Force -データベースを強制的に閉じて接続されているクライアントの接続を解除するかどうかを指定します。[Grace time] オプションよりは上書きされます。[Status] が「Closed」に設定されている場合にのみ許可されます。 |
Boolean |
|
|
Set authenticated stream setting - ストリーミング URL の Cookie チェック設定を設定します。 |
Secure DB - Cookie をチェックするかどうかを選択します。Cookie チェックを使用する: 1。Cookie チェックを使用しない: 2。 |
Number |
|
Send message to client - クライアントにメッセージを送信します。 |
Client ID - クライアントの ID を入力します。 |
String |
|
Message text - クライアントに送信するメッセージ。 |
String |
|
|
Change status of FileMaker Data API settings - FileMaker Data API 設定の状態を変更します。 |
Enabled - FileMaker Data API を有効にするかどうかを指定します。 |
Boolean |
|
Change status of OData API settings - OData API 設定の状態を変更します。 |
Enabled - OData API を有効にするかどうかを指定します。 |
Boolean |
|
Delete schedule - スケジュールを削除します。 |
Schedule ID - スケジュールの ID。スケジュール ID 1 は FileMaker Server によって予約されています。 |
String |
|
Disconnect client - クライアントの接続を解除します。 |
Client ID - クライアントの ID を入力します。 |
String |
|
Message text - 接続が解除されるクライアントに送信するメッセージ。 |
String |
|
|
Grace time - クライアントの接続を解除するまでに待機する秒数。デフォルト: 90 秒。 |
String |
|
|
Duplicate schedule - スケジュール ID によって指定されたスケジュールを複製します。 |
Schedule ID - スケジュールの ID。スケジュール ID 1 は FileMaker Server によって予約されています。 |
String |
|
Get all databases - すべてのデータベースを返します。 |
|
|
|
Get all clients - すべてのクライアントの一覧を返します。 |
|
|
|
Get all schedules - すべてのスケジュールの一覧を返します。 |
|
|
|
Get schedule - スケジュールを返します。 |
Schedule ID - スケジュールの ID。スケジュール ID 1 は FileMaker Server によって予約されています。 |
String |
|
Get authenticated stream setting - 認証済みストリーム設定を返します。 |
|
|
|
Get FileMaker Data API settings - FileMaker Data API 設定を返します。 |
|
|
|
Get OData API settings - OData API 設定を返します。 |
|
|
|