OpenAPI の概要 › OpenAPI クエリについて › OpenAPI クエリの作成

OpenAPI クエリの作成

OpenAPI Query Builder では、Query URL を作成できます。 クエリ内のすべてのパラメータには、対応するパラメータが OpenAPI によって Query URL に追加されます。 使用可能なパラメータは、コンポーネント、デバイス、ルータ、またはクエリを実行するその他のアイテムによって異なります。

以下の手順に従います。

1. ［Specify the Query］フィールドをクリックして、クエリを開始します。

   トークンのリストが表示されます。

2. トークンまたはレシピを選択します。

   ［Specify the Query］フィールドにトークンまたはレシピが表示されます。

   Web ブラウザのアドレス バーが更新され、［Specify the Query］フィールドで加えた変更内容が表示されます。 自分または別のユーザが引き続き後でクエリの編集を行う場合は、記録用にこの URL をコピーし保存します。

3. 使用可能なトークンを使用して、クエリを完成させます。
4. ［Format］および［Payload］オプションをクリックして、データのフォーマットをカスタマイズします。

   ソート方法、返すアイテムの数、およびデータの形式を選択します。

5. （オプション）［Run］ボタンをクリックします。

   OpenAPI によってクエリが実行され、選択した形式で結果が表示されます。

6. コピー（）ボタンをクリックします。

   Query URL がクリップボードにコピーされ、Web ブラウザまたは REST ツールに貼り付けできます。

   すべての OpenAPI クエリのベース URL は以下のとおりです。

   http://hostname： port/odata/api/
   

重要： 大きな結果セットを返すクエリは、システムに悪影響を及ぼす可能性があります。 要求に関連する結果のみを返すようにクエリを改良することをお勧めします。