Admin API 呼び出しの一覧
次の表に FileMaker Server または FileMaker Cloud でサポートされている API 呼び出しを示します。API 呼び出しの詳細については、Admin API Referenceを参照してください。
| API 呼び出し | FileMaker Server | FileMaker Cloud |
|---|---|---|
|
認証 |
||
|
Get Restricted Access (制限されたアクセスの取得) |
はい |
いいえ |
|
Update Restricted Access (制限されたアクセスの更新) |
はい |
いいえ |
|
Request Access Token (アクセストークンの要求) |
はい |
はい |
|
Invalidate Access Token (アクセストークンの無効化) |
はい |
はい |
|
Authentication (認証) |
いいえ |
一部1 |
|
データベースサーバー |
||
|
Get Server Metadata (サーバーメタデータの取得) |
はい |
いいえ |
|
Update Admin Console Account (Admin Console アカウントの更新) |
はい |
いいえ |
|
Update Server Name (サーバー名の更新) |
はい |
いいえ |
|
Get Server Status (サーバー状態の取得) |
はい |
いいえ |
|
Update Server Status (サーバー状態の更新) |
はい |
いいえ |
|
Get Administrator Contact Information (管理者連絡先情報の取得) |
はい |
いいえ |
|
Update Administrator Contact Information (管理者連絡先情報の更新) |
はい |
いいえ |
|
Get Administrator Roles Server Setting (管理者の役割サーバー設定の取得) |
はい |
いいえ |
|
Create Administrator Role Server Setting (管理者の役割サーバー設定の作成) |
はい |
いいえ |
|
Update Administrator Role Server Setting (管理者の役割サーバー設定の更新) |
はい |
いいえ |
|
Delete Administrator Roles Server Setting (管理者の役割サーバー設定の削除) |
はい |
いいえ |
|
Get Server Security Setting (サーバーのセキュリティ設定の取得) |
はい |
いいえ |
|
Update Server Security Setting (サーバーのセキュリティ設定の更新) |
はい |
いいえ |
|
Get Server General Settings (サーバーの一般設定の取得) |
はい |
いいえ |
|
Update Server General Settings (サーバーの一般設定の更新) |
はい |
いいえ |
|
Update Server Progressive Backups Setting (サーバーのプログレッシブバックアップ設定の更新) |
はい |
いいえ |
|
Cancel Currently Running Backup (現在実行中のバックアップのキャンセル) |
はい |
いいえ |
|
Enable/Disable Server Additional Database Folder Settings (サーバーの追加のデータベースフォルダ設定の有効化/無効化) |
はい |
いいえ |
|
Enable/Disable Server Discovery Setting (サーバーの検出設定の有効化/無効化) |
はい |
いいえ |
|
Get Authenticated Stream Setting (認証済みストリーム設定の取得) |
はい |
はい |
|
Set Authenticated Stream Setting (認証済みストリーム設定の設定) |
はい |
はい |
|
Allow Certificate With Unknown Revocation Status (失効ステータスが不明な証明書の許可) (取得) |
はい |
いいえ |
|
Allow Certificate With Unknown Revocation Status (失効ステータスが不明な証明書の許可) (更新) |
はい |
いいえ |
|
Get Server Parallel Backup Setting (サーバーのパラレルバックアップ設定の取得) |
はい |
いいえ |
|
Update Server Parallel Backup Setting (サーバーのパラレルバックアップ設定の更新) |
はい |
いいえ |
|
Get Restrict Access (制限されたアクセスの取得) |
はい |
いいえ |
|
Update Restrict Access (制限されたアクセスの更新) |
はい |
いいえ |
|
Get FileMaker Admin API Public Keys Server Setting (FileMaker Admin API パブリックキーサーバー設定の取得) |
はい |
いいえ |
|
Add FileMaker Admin API Public Key Server Setting (FileMaker Admin API パブリックキーサーバー設定の追加) |
はい |
いいえ |
|
Update FileMaker Admin API Public Keys Server Setting (FileMaker Admin API パブリックキーサーバー設定の更新) |
はい |
いいえ |
|
Delete FileMaker Admin API Public Keys (FileMaker Admin API パブリックキーの削除) |
はい |
いいえ |
|
Get Persistent Cache Setting (持続的なキャッシュ設定の取得) |
はい |
いいえ |
|
Set Persistent Cache Setting (持続的なキャッシュ設定の設定) |
はい |
いいえ |
|
Get Block New Users Setting (新規ユーザをブロックする設定の取得) |
はい |
いいえ |
|
Set Block New Users Setting (新規ユーザをブロックする設定の設定) |
はい |
いいえ |
|
Get Server Current Folder Settings (サーバーの現在のフォルダ設定の取得) |
はい |
いいえ |
|
Get Server Additional Database Folder Paths (サーバーの追加のデータベースフォルダパスの取得) |
はい |
いいえ |
|
Get Server Additional Remote Container Folder Paths (サーバーの追加のリモートオブジェクトフォルダパスの取得) |
はい |
いいえ |
|
Get Server Backup Folder Path (サーバーのバックアップフォルダパスの取得) |
はい |
いいえ |
|
Update Server Default Backup Folder Path (サーバーのデフォルトバックアップフォルダパスの更新) |
はい |
いいえ |
|
Get Server Progressive Backup Folder Path (サーバーのプログレッシブバックアップフォルダパスの取得) |
はい |
いいえ |
|
Update Server Progressive Backup Folder Path (サーバーのプログレッシブバックアップフォルダパスの更新) |
はい |
いいえ |
|
データベース |
||
|
List Databases (データベースの一覧) |
はい |
はい |
|
Perform Database Operations for All Databases (すべてのデータベースにデータベース操作を実行) |
はい |
はい |
|
Perform Database Operations for a Database (1 つのデータベースにデータベース操作を実行) |
はい |
はい |
|
Remove a Database (データベースを取り除く) |
はい |
はい |
|
Download Database (データベースをダウンロード) |
はい |
はい |
|
Upload Database (データベースをアップロード) |
はい |
いいえ |
|
クライアントの管理 |
||
|
List Clients (クライアントの一覧) |
はい |
はい |
|
Send Message to Client (クライアントにメッセージを送信) |
はい |
はい |
|
Disconnect Client (クライアントの接続解除) |
はい |
はい |
|
スケジュール |
||
|
List Schedules (スケジュールの一覧) |
はい |
はい |
|
Duplicate Schedule (スケジュールの複製) |
はい |
はい |
|
Create Backup Schedule (バックアップスケジュールの作成) |
はい |
いいえ |
|
Create FileMaker Script Schedule (FileMaker スクリプトスケジュールの作成) |
はい |
一部2 |
|
Create Message Schedule (メッセージスケジュールの作成) |
はい |
一部3 |
|
Create Script Sequence Schedule (スクリプトシーケンススケジュールの作成) |
はい |
いいえ |
|
Create System Script Schedule (システムスクリプトスケジュールの作成) |
はい |
いいえ |
|
Create Verify Schedule (検証スケジュールの作成) |
はい |
いいえ |
|
Get Schedule (スケジュールの取得) |
はい |
はい |
|
Edit/Run Schedule (スケジュールの編集/実行) |
はい |
一部2 |
|
Delete Schedule (スケジュールの削除) |
はい |
はい |
|
PHP |
||
|
PHP Settings (PHP 設定) |
はい |
いいえ |
|
Update PHP Settings (PHP 設定の更新) |
はい |
いいえ |
|
XML |
||
|
XML Settings (XML 設定) |
はい |
いいえ |
|
Update XML Settings (XML 設定の更新) |
はい |
いいえ |
|
ODBC/JDBC |
||
|
ODBC/JDBC Settings (ODBC/JDBC 設定) |
はい |
いいえ |
|
Update ODBC/JDBC Settings (ODBC/JDBC 設定の更新) |
はい |
いいえ |
|
FileMaker Data API |
||
|
FileMaker Data API Usage (FileMaker Data API 使用状況) |
はい |
いいえ |
|
FileMaker Data API Settings (FileMaker Data API 設定) |
はい |
はい |
|
Update FileMaker Data API Settings (FileMaker Data API 設定の更新) |
はい |
はい |
|
Web 公開エンジン |
||
|
FileMaker WebDirect Settings (FileMaker WebDirect 設定) |
はい |
いいえ |
|
Update FileMaker WebDirect Settings (FileMaker WebDirect 設定の更新) |
はい |
いいえ |
|
WPE Settings for All Machines (すべてのマシンの WPE 設定) |
はい |
いいえ |
|
WPE Settings for a Single Machine (1 台のマシンの WPE 設定) |
はい |
いいえ |
|
Update WPE Settings (WPE 設定の更新) |
はい |
いいえ |
|
Get Nginx Load Balancer URL Setting (Nginx ロードバランサ URL 設定の取得) |
一部4 |
いいえ |
|
Update Nginx Load Balancer URL Setting (Nginx ロードバランサ URL 設定の更新) |
一部4 |
いいえ |
|
Get Maximum Number of CWP Connections Setting (CWP 最大接続数設定の取得) |
はい |
いいえ |
|
Update Maximum Number of CWP Connections Setting (CWP 最大接続数設定の更新) |
はい |
いいえ |
|
OData |
||
|
OData Settings (OData 設定) |
はい |
はい |
|
Update OData Settings (OData 設定の更新) |
はい |
はい |
|
ライセンス |
||
|
Get License Information (ライセンス情報の取得) |
はい |
いいえ |
|
Import License (ライセンスのインポート) |
はい |
いいえ |
|
Sync Up License (ライセンスの同期) |
はい |
いいえ |
|
通知 |
||
|
Enable/Disable Email Notifications (電子メール通知の有効化/無効化) |
はい |
いいえ |
|
Get Email Notification Settings (電子メール通知設定の取得) |
はい |
いいえ |
|
Update Email Notification Settings (電子メール通知設定の更新) |
はい |
いいえ |
|
外部認証 |
||
|
Get External Account Group Name (外部アカウントのグループ名の取得) |
はい |
いいえ |
|
Update External Account Group Name (外部アカウントのグループ名の更新) |
はい |
いいえ |
|
Get Amazon Identity Provider Information (Amazon アイデンティティプロバイダ情報の取得) |
はい |
いいえ |
|
Update Amazon Identity Provider Information (Amazon アイデンティティプロバイダ情報の更新) |
はい |
いいえ |
|
Get Google Identity Provider Information (Google アイデンティティプロバイダ情報の取得) |
はい |
いいえ |
|
Update Google Identity Provider Information (Google アイデンティティプロバイダ情報の更新) |
はい |
いいえ |
|
Get Microsoft Identity Provider Information (Microsoft アイデンティティプロバイダ情報の取得) |
はい |
いいえ |
|
Update Microsoft Identity Provider Information (Microsoft アイデンティティプロバイダ情報の更新) |
はい |
いいえ |
|
Get Custom OAuth Identity Provider Information (カスタム OAuth アイデンティティプロバイダ情報の取得) |
はい |
いいえ |
|
Update Custom OAuth Identity Provider Information (カスタム OAuth アイデンティティプロバイダ情報の更新) |
はい |
いいえ |
|
Get AppleID Identity Provider Information (AppleID アイデンティティプロバイダ情報の取得) |
はい |
いいえ |
|
Update AppleID Identity Provider Information (AppleID アイデンティティプロバイダ情報の更新) |
はい |
いいえ |
|
Enable/Disable Admin Console Sign-in (Admin Console サインインの有効化/無効化) |
はい |
いいえ |
|
Get Database Sign-in Settings for External Server Accounts (外部サーバーアカウントのデータベースサインイン設定の取得) |
はい |
いいえ |
|
Update Database Sign-in Settings for External Server Accounts (外部サーバーアカウントのデータベースサインイン設定の更新) |
はい |
いいえ |
|
Get Database Sign-in Settings for Amazon (Amazon のデータベースサインイン設定の取得) |
はい |
いいえ |
|
Update Database Sign-in Settings for Amazon (Amazon のデータベースサインイン設定の更新) |
はい |
いいえ |
|
Get Database Sign-in Settings for Google (Google のデータベースサインイン設定の取得) |
はい |
いいえ |
|
Update Database Sign-in Settings for Google (Google のデータベースサインイン設定の更新) |
はい |
いいえ |
|
Get Database Sign-in Settings for Microsoft (Microsoft のデータベースサインイン設定の取得) |
はい |
いいえ |
|
Update Database Sign-in Settings for Microsoft (Microsoft のデータベースサインイン設定の更新) |
はい |
いいえ |
|
Get Database Sign-in Settings for AppleID (AppleID のデータベースサインイン設定の取得) |
はい |
いいえ |
|
Update Database Sign-in Settings for AppleID (AppleID のデータベースサインイン設定の更新) |
はい |
いいえ |
|
Get Database Sign-in Settings for Custom OAuth (カスタム OAuth のデータベースサインイン設定の取得) |
はい |
いいえ |
|
Update Database Sign-in Settings for Custom OAuth (カスタム OAuth のデータベースサインイン設定の更新) |
はい |
いいえ |
|
FileMaker クライアントの設定 |
||
|
FileMaker Pro and FileMaker Go Session Timeout Setting (FileMaker Pro および FileMaker Go のセッションタイムアウトの設定) |
はい |
いいえ |
|
Update FileMaker Pro and FileMaker Go Session Timeout (FileMaker Pro および FileMaker Go のセッションタイムアウトの更新) |
はい |
いいえ |
|
FileMaker WebDirect Session Timeout Setting (FileMaker WebDirect のセッションタイムアウトの設定) |
はい |
いいえ |
|
Update FileMaker WebDirect Session Timeout (FileMaker WebDirect のセッションタイムアウトの更新) |
はい |
いいえ |
|
Get Database Filtering Setting (データベースフィルタリング設定の取得) |
はい |
いいえ |
|
Enable/Disable Database Filtering (データベースフィルタリングの有効化/無効化) |
はい |
いいえ |
|
SSL 証明書 |
||
|
Create SSL CSR (SSL CSR の作成) |
はい |
いいえ |
|
Get Server Certificate Information (サーバー証明書情報の取得) |
はい |
いいえ |
|
Import SSL Certificate (SSL 証明書のインポート) |
はい |
いいえ |
|
Delete SSL Certificate (SSL 証明書の削除) |
はい |
いいえ |
|
FM プラグイン |
||
|
Get Plug-in List (プラグイン一覧の取得) |
はい |
いいえ |
|
Enable/Disable Individual Plug-in (個々のプラグインの有効化/無効化) |
はい |
いいえ |
|
Enable/Disable WPE Install Plug-in Script (WPE インストールプラグインスクリプトの有効化/無効化) |
はい |
いいえ |
|
Enable/Disable WPE Plug-ins (WPE プラグインの有効化/無効化) |
はい |
いいえ |
|
Enable/Disable DBS Install Plug-ins Script (DBS インストールプラグインスクリプトの有効化/無効化) |
はい |
いいえ |
|
Enable/Disable DBS Plug-ins (DBS プラグインの有効化/無効化) |
はい |
いいえ |
|
Enable/Disable DAPI Install Plug-in Script (DAPI インストールプラグインスクリプトの有効化/無効化) |
はい |
いいえ |
|
Enable/Disable DAPI Plug-ins (DAPI プラグインの有効化/無効化) |
はい |
いいえ |
|
Get DBS Plug-in Configuration (DBS プラグイン構成の取得) |
はい |
いいえ |
|
Get WPE Plug-in Configuration (WPE プラグイン構成の取得) |
はい |
いいえ |
|
Get DAPI Plug-in Configuration (DAPI プラグイン構成の取得) |
はい |
いいえ |
|
カスタム App の更新 |
||
|
Update (更新) |
いいえ |
はい |
|
カスタム App のアップロード |
||
|
Get Database Upload Info (データベースアップロード情報の取得) |
いいえ |
はい |
|
Check File Upload (ファイルアップロードのチェック) |
いいえ |
はい |
|
Database Upload Event (データベースアップロードイベント) |
いいえ |
はい |
|
Upload (アップロード) |
いいえ |
はい |
|
Append (追加)(廃止) |
いいえ |
はい |
|
Append Multiple Parts (複数の部分を追加) |
いいえ |
はい |
|
ユーザをチームに招待およびユーザをグループに追加 |
||
|
Invite Users to a Team (ユーザをチームに招待) |
いいえ |
はい |
|
Add Users to a Group (ユーザをグループに追加) |
いいえ |
はい |
-
FileMaker Cloud でカスタム App を更新およびアップロード API 呼び出しの場合のみ利用できます。
-
sendEmail 引数はサポートされていません。
-
sendEmail 引数および resourceType 引数の DB_IN_FOLDER 値はサポートされていません。
-
Nginx ロードバランサは Linux 上の FileMaker Server でのみサポートされています。
メモ
-
FileMaker Cloud では startTimeStamp 引数に UTC 時刻を使用します。
-
filemakerScriptType の場合、実行するスクリプトに fmScriptAccount および fmScriptPassword 引数の両方を渡す必要があります。
-
FileMaker Cloud の filemakerScriptType の場合、fmScriptAccount 引数を使用して Claris ID トークンを指定し、fmScriptPassword 引数で Claris ID 更新トークンを指定する必要があります。更新トークンを指定しない場合、Claris ID トークンが期限切れになった後はスクリプトを実行できません。トークンを生成する方法については、Claris Customer Console ヘルプを参照してください。
-
FileMaker Admin API を使用してスケジュールを作成する場合、FileMaker Admin API はアカウントやパスワードなどの API リクエストで指定された値を検証しない場合があります。
-
Get Schedule (スケジュールの取得) 呼び出しには schedule_id 引数が必要です。スケジュール ID を探すには、Get Schedule 呼び出しを使用してすべてのスケジュールとその設定の一覧を表示します。
-
List Databases (データベースの一覧) の呼び出しの状態引数に対して返された値が「Normal」の場合、データベースは開いています。
-
データベースに関連する API 呼び出し、およびスケジュールの作成とスケジュールの編集/実行呼び出し以外のスケジュールの API 呼び出しは非同期のため FileMaker Cloud または FileMaker Server からの応答を待機しません。非同期の呼び出しの後は、続けて取得の呼び出しを使用してファイルの状態が変更されたことを確認する必要があります。たとえば、データベースを閉じる呼び出しの後、続けてデータベース取得の呼び出しを使用してデータベースが閉じられたことを確認します。すぐに状態が変更されない場合はチェックを続行します。それ以外の API 呼び出しは同期して FileMaker Cloud または FileMaker Server からの応答を待機します。
-
Upload Database (データベースをアップロード) 呼び出しは外部オブジェクトデータのアップロードをサポートしていないため、データベースのみをアップロードします。