たとえば、GET /objects/networks/{objId} は特定のオブジェクトの ID を必要とします。GET /objects/networks メソッドを使用してネットワーク オブジェクトのリストを取得し、調べるオブジェクトの id 値を探します。この場合、GET /object/networks コールで返される情報は GET /objects/network/{objId} の場合と同じになることに注意してください。オブジェクト ID（objId）と親 ID の検索を参照してください。

• objId：オブジェクト ID は、URL 内で必要な場合は常に必要です。たとえば、900fac69-7d19-11e7-bf7b-d9417b20e59e です。

• parentId：親 ID はオブジェクト ID と同等ですが、単に階層内で高い位置にある親に対するものです。たとえば、GET /policy/intrusion は侵入ポリシーのリストを返しますが、GET /policy/intrusion/{parentId}/intrusionrules はそれらのポリシーの 1 つで定義されているルールを返します。親 ID は GET /policy/intrusion から取得します。

• offset：複数のオブジェクトをサポートするリソースの場合、オブジェクトを返すのを開始するリスト内の位置。デフォルトは 0 で、リストの先頭を示します。

• limit：応答で返されるオブジェクトの最大数。デフォルトは 10 です。最大値は 1000 です。無効な値を入力すると、自動的に 1000 に変更されます。

• sort：応答で返されるオブジェクトを並べ替える方法。デフォルトの並べ替え順は、name 値でアルファベット順です。並べ替え順を変更するには、並べ替えに使用するリソース内の属性の名前を入力します。たとえば、ネットワーク オブジェクトで sort=value を使用すると、value 属性（つまり IP アドレス）で並べ替えることができます。逆順に並べ替えるには、マイナス記号を含めます（例：sort=-name）。

• filter（一部のリソースでは使用不可）：フィルタ条件に一致する項目のみを返します。フィルタ値の形式は {キー}{演算子}{値} で、キーは属性名、値はフィルタに使用する文字列です。項目間にスペースはありません。フィルタ処理できるフィールドは、API エクスプローラの filter パラメータの説明に一覧表示されています。フィールドはオブジェクトごとに異なります。複数フィールドのフィルタリングをサポートしているオブジェクトの場合、複数の値をセミコロン（;）で区切って filter パラメータに含めることができます。たとえば、GET /policy/intrusionpolicies/{parentId}/intrusionrules の gid:1;sid:105 をフィルタ処理できます。使用可能な演算子は次のとおりです。

  • :：等号。たとえば、filter=name!Canada です。

  • !：不等号。たとえば、filter=name!Canada です。

  • ~：類似。たとえば、filter=name~United です。

• filter=fts~string（一部のリソースでは使用不可）：フィルタに一致する項目のみを返します。Fts~ オプションはフルテキスト検索を指定します。オブジェクト内の全属性で文字列が検索されます。オプションで部分文字列を使用できます。アスタリスク（*）をワイルドカードとして使用し、1 文字以上と一致させます。次の文字を含めないでください。検索文字列の一部としてサポートされていません。?~!{}<>:%。次の文字は無視されます。;#&。

  たとえば、GET /object/networks?filter=fts~10 を使用して、最初のオクテットとして 10 を持つすべてのネットワークオブジェクトを見つけることができます。新しく作成された、または更新されたオブジェクトのインデックス化には 3 ～ 5 秒かかるため、それらのオブジェクトのフルテキスト検索を実行する前に少し待つ必要があります。

• filter=fetchZeroHitCount:{true | false}（アクセスルールのみで使用可能）：includeHitCounts=true を指定した場合、このフィルタオプションを使用して、ヒットしていない（つまりヒットカウントがゼロである）ルールを含める（true）または除外（false）することができます。デフォルトは true です。

• includeHitCounts（アクセスルールのみで使用可能）：ポリシーにルールのヒットカウント情報を含めるかどうか。ヒットカウントを取得するには、includeHitCounts=true を指定します。false（デフォルト）を指定してヒットカウントを除外します。ヒットカウント情報は、返されたオブジェクトの hitCount 属性で返されます。

• time_duration（トレンド レポートの場合にのみ使用可能）：過去何秒間までのレポートを含めるか。たとえば、1800 は過去 30 分のレポートを返します。

コールが成功すると（戻りコード 200）、応答本文にはコールの内容に応じて 1 つのオブジェクトまたはオブジェクトのリストが含まれています。応答の一般的な構造と内容については、メソッドの試行と結果の解釈を参照してください。

GET 要求にはページング セクションが含まれています。コールで返されたオブジェクトより多くのオブジェクトが存在する場合、prev および next の値はその前または後のオブジェクトセットを取得する方法を示しています。count 値はオブジェクト全体の数を示しています。limit 値は応答で返される項目数を示しています。offset 値は返されるオブジェクトの開始位置を示しており、0 はリストの先頭を示しています。

"paging": {
    "prev": [],
    "next": [
      "https://ftd.example.com/api/fdm/[最新（latest）]/object/networks?limit=10&offset=10"
    ],
    "limit": 10,
    "offset": 0,
    "count": 22,
    "pages": 0
  }

• [parentId]：このオブジェクトを含む親オブジェクトの ID。たとえば、SSL ルールを追加する場合は、SSL 復号ポリシーの ID。

• [at]：番号付きリストでオブジェクトを編成する親に属するオブジェクト（SSL 復号ポリシーなど）の場合は、その場所をオブジェクトに挿入します。整数を使用して場所を示します（リストの先頭は 0）。デフォルトでは、新しいオブジェクトはリストの最後に追加されます。

このボックスをクリックすると、JSON モデルが body パラメータの [値（Value）] 列にロードされます。たとえば、POST /object/networks リソースのボックスをクリックすると、次の本文がロードされます。

{
  "name": "string",
  "description": "string",
  "subType": "HOST",
  "value": "string",
  "type": "networkobject"
}

列挙値の場合は、必ず [応答クラス（Response Class）] > [モデル（Model）] で許可される値を確認してください。たとえば、値を入力して [subType] のデフォルト値を変更することにより、サブネット（ホストではない）アドレスのネットワーク オブジェクトを作成できます。

{
  "name": "new_network_object",
  "description": "A subnet object created using the REST API.",
  "subType": "NETWORK",
  "value": "10.100.10.0/24",
  "type": "networkobject"
}

システムの更新に使用される curl コマンドを調べます。追加のヘッダーに注意してください。API クライアントを作成するときは、これらのヘッダー フィールドと値も含める必要があります。たとえば、サンプルオブジェクトを作成するための curl コマンドは次のとおりです。Content-Type ヘッダーと Accept ヘッダーに注意してください。

curl -X POST --header 'Content-Type: application/json' \
   --header 'Accept: application/json' -d '{ \ 
   "name": "new_network_object", \ 
   "description": "A subnet object created using the REST API.", \ 
   "subType": "NETWORK", \ 
   "value": "10.100.10.0/24", \ 
   "type": "networkobject" \ 
 }' 'https://ftd.example.com/api/fdm/[最新（latest）]/object/networks'

コールが成功すると（戻りコード 200）、応答本文には作成した完全なオブジェクトが含まれていて、version や id などのその他のシステム生成値も含まれています。バージョンおよび ID の値は、その後オブジェクトを変更するために PUT を使用する場合に必要になるため、特に重要です。応答の一般的な構造と内容については、メソッドの試行と結果の解釈を参照してください。

応答本文には、作成したオブジェクトの URL である links/self 値も含まれています。たとえば、サンプル オブジェクトの応答本文は次のとおりです。

{
  "version": "f6d8da48-7ed5-11e7-9bfd-d96183b5f5f1",
  "name": "new_network_object",
  "description": "A subnet object created using the REST API.",
  "subType": "NETWORK",
  "value": "10.100.10.0/24",
  "isSystemDefined": false,
  "id": "f6d8da49-7ed5-11e7-9bfd-27136f5686ad",
  "type": "networkobject",
  "links": {
    "self": "https://ftd.example.com/api/fdm/[最新（latest）]/object/networks/
f6d8da49-7ed5-11e7-9bfd-27136f5686ad"
  }
}

• [objId]：オブジェクトの id 値。たとえば、900fac69-7d19-11e7-bf7b-d9417b20e59e です。

• [parentId]：別のオブジェクト内にあるオブジェクトの場合、このオブジェクトを含む親オブジェクトの ID。たとえば、SSL ルールを変更する場合は、SSL 復号ポリシーの ID。

• [at]：番号付きリストでオブジェクトを編成する親に属するオブジェクト（SSL 復号ポリシーなど）の場合は、その場所をオブジェクトに挿入します。整数を使用して場所を示します（リストの先頭は 0）。デフォルトでは、オブジェクトはリストの最後に挿入されます。

このボックスをクリックすると、JSON モデルが body パラメータの [値（Value）] 列にロードされます。たとえば、PUT /object/networks リソースのボックスをクリックすると、次の本文がロードされます。これは、同じリソースに対する POST バージョンとは少し異なっていることに注意してください。PUT 本文には version 属性が含まれています。

{
  "version": "string",
  "name": "string",
  "description": "string",
  "subType": "HOST",
  "value": "string",
  "type": "networkobject"
}

変更しない古い値を必ず複製してください。

列挙値の場合は、必ず [応答クラス（Response Class）] > [モデル（Model）] で許可される値を確認してください。オブジェクトを別のサブタイプに変更する場合を除き、古い値を繰り返し使用します。たとえば、ネットワークオブジェクトのデフォルトの PUT モデルでは subType は HOST ですが、サブネットオブジェクトを変更する場合は必ず subType を NETWORK に変更します。

たとえば、ネットワークオブジェクト内のサブネット IP アドレスを更新するには、value を除くすべての属性の古い値をすべて繰り返し使用します。新しいサブネットアドレスを value に入力します。

{
  "version": "f6d8da48-7ed5-11e7-9bfd-d96183b5f5f1",
  "name": "new_network_object",
  "description": "A subnet object created using the REST API.",
  "subType": "NETWORK",
  "value": "10.100.11.0/24",
  "type": "networkobject",
}

システムの更新に使用される curl コマンドを調べます。追加のヘッダーに注意してください。API クライアントを作成するときは、これらのヘッダー フィールドと値も含める必要があります。たとえば、サンプルオブジェクトを更新するための curl コマンドは次のとおりです。Content-Type ヘッダーと Accept ヘッダーに注意してください。

curl -X PUT --header 'Content-Type: application/json' \
--header 'Accept: application/json' -d '{ \ 
   "version": "f6d8da48-7ed5-11e7-9bfd-d96183b5f5f1", \ 
   "name": "new_network_object", \ 
   "description": "A subnet object created using the REST API.", \ 
   "subType": "NETWORK", \ 
   "value": "10.100.11.0/24", \ 
   "type": "networkobject" \ 
 }' 'https://ftd.example.com/api/fdm/[最新（latest）]/object/
networks/f6d8da49-7ed5-11e7-9bfd-27136f5686ad'

コールが成功すると（戻りコード 200）、応答本文には更新した完全なオブジェクトが含まれています。バージョン値は変更されますが、オブジェクト ID は（したがって link/self も）同じままです。オブジェクトを変更するたびに、バージョンが変更されます。応答の一般的な構造と内容については、メソッドの試行と結果の解釈を参照してください。

たとえば、サンプル オブジェクト更新の応答本文は次のとおりです。

{
  "version": "96f5f3cc-7ede-11e7-9bfd-9b7d8a92863f",
  "name": "new_network_object",
  "description": "A subnet object created using the REST API.",
  "subType": "NETWORK",
  "value": "10.100.11.0/24",
  "isSystemDefined": false,
  "id": "f6d8da49-7ed5-11e7-9bfd-27136f5686ad",
  "type": "networkobject",
  "links": {
    "self": "https://ftd.example.com/api/fdm/[最新（latest）]/object/networks/
f6d8da49-7ed5-11e7-9bfd-27136f5686ad"
  }
}

該当オブジェクトがコンテナ内に存在する場合は、親オブジェクトの ID も [parentId] フィールドに入力する必要があります。

システムからオブジェクトを削除するために使用する curl コマンドを調べます。追加のヘッダーに注意してください。API クライアントを作成するときは、これらのヘッダー フィールドと値も含める必要があります。たとえば、サンプルオブジェクトを削除するための curl コマンドは以下のとおりです。Accept ヘッダーに注意してください。

curl -X DELETE --header 'Accept: application/json' 
'https://ftd.example.com/api/fdm/[最新（latest）]/object/
networks/f6d8da49-7ed5-11e7-9bfd-27136f5686ad'

コールが成功すると（戻りコード 204 「コンテンツがありません」）、空の応答本文を受け取ります。これは予期されている結果です。