メソッドの試行と結果の解釈
API エクスプローラを使用すると、さまざまなメソッドをテストすることができます。このトピックでは、一般的なプロセスについて、システムが返す応答の説明とともに説明します。メソッドに関連する具体的なテクニックは、各メソッド タイプのトピックを参照してください。
各メソッド/リソースの [試してみよう!（Try It Out!）] ボタンにより、システムと直接対話します。GET は、実際のデータを取得し、POST/PUT は実際のリソースを作成または変更し、DELETE は実際のオブジェクトを削除します。変更はすぐには展開されませんが、システムで実際の設定変更を行っています。変更をアクティブにするには、POST /operational/deploy リソースを使用して展開ジョブを開始します。
メソッド/リソースを開くと、[応答メッセージ（Response Message）] セクションの後に、[試してみよう!（Try It Out!）] ボタンを見つけることができます。メソッド/リソースによっては、テストするにはオブジェクト ID を入力する必要があります。この場合、通常、まず親リソースで GET を実行する必要があります。詳細については、オブジェクト ID（objId）と親 ID の検索を参照してください。
POST/PUT でも、JSON モデルに必要な値を入力する必要があります。
[試してみよう!（Try It Out!）] をクリックした後、API エクスプローラは、ボタンの後のページに結果を追加します。この応答には次のセクションが含まれます。
- Curl
-
呼び出しを行うために使用される curl コマンド。たとえば、GET /object/networks リソースで [試してみよう!（Try It Out!）] をクリックすると、次のようなメッセージが返されます。パスの要素「v」は、新しいバージョンの API によって変わります。
curl -X GET --header 'Accept: application/json' 'https://ftd.example.com/api/fdm/[最新（latest）]/object/networks'
（注）
これには [認証：べアラー（Authorization: Bearer）] ヘッダーは含まれません。これはクライアントからの API 呼び出しで必要になります。
- 要求 URL
-
要求を行うクライアントから発行する URL です。たとえば、GET /object/networks の場合：
https://ftd.example.com/api/fdm/[最新（latest）]/object/networks - レスポンス ボディ
-
システムがクライアントに返すオブジェクト。リソースに複数のオブジェクト（/object/network など）を含めることができる場合、GET 要求でアイテムのリストを取得します。POST/PUT/DELETE の応答は、ほとんど単一のオブジェクトです。
返される特定のコンテンツは、リソース モデルに基づきます。たとえば、GET /object/networks は次のような各オブジェクトを含む、オブジェクトのリストを返します（最初のアイテムのリストも表示されます）。リンク/自己値は、このオブジェクトを参照するために使用する URL を示すことに注意してください。オブジェクト ID は URL に含まれます。
{ "items": [ { "version": "900f8558-7d19-11e7-bf7b-3dcaf0c58345", "name": "AIM_SERVERS-205.188.1.132", "description": null, "subType": "HOST", "value": "205.188.1.132", "isSystemDefined": true, "id": "900fac69-7d19-11e7-bf7b-d9417b20e59e", "type": "networkobject", "links": { "self": "https://ftd.example.com/api/fdm/[最新（latest）]/ object/networks/900fac69-7d19-11e7-bf7b-d9417b20e59e" } },GET 要求もページングのセクションに含まれます。これはGET：システムからのデータの取得で説明されています。
- 応答コード
-
HTTP 呼び出しの数値 HTTP ステータス コードが返されます。これらは、標準の HTTP ステータス コードで、RFC やウィキペディア（https://en.wikipedia.org/wiki/List_of_HTTP_status_codes など）で検索できます。たとえば、200 (OK) は、GET/PUT/POST 呼び出しの成功を示し、204 は DELETE 呼び出しの成功を示します。
- レスポンス ヘッダー
-
HTTP 応答のパケット ヘッダーです。たとえば、GET /object/networks には、次のようなヘッダーがあります。
{ "date": "Thu, 10 Aug 2017 19:19:16 GMT", "content-encoding": "gzip", "x-content-type-options": "nosniff", "transfer-encoding": "chunked", "connection": "Keep-Alive", "vary": "Accept-Encoding", "x-xss-protection": "1; mode=block", "pragma": "no-cache", "server": "Apache", "x-frame-options": "SAMEORIGIN", "strict-transport-security": "max-age=31536000 ; includeSubDomains", "content-type": "application/json;charset=UTF-8", "cache-control": "no-cache, no-store, max-age=0, must-revalidate", "accept-ranges": "bytes", "keep-alive": "timeout=5, max=99", "expires": "0" }
フィードバック