關於 OpenAPI › 關於 OpenAPI 查詢 › 建立 OpenAPI 查詢

建立 OpenAPI 查詢

OpenAPI 查詢產生器可讓您建立查詢 URL。 針對查詢中的每個參數，OpenAPI 會新增相對應的參數至查詢 URL。 參數是否可用，取決於您要查詢的元件、裝置、路由器或其他項目。

遵循這些步驟：

1. 按一下 [指定查詢] 欄位開始查詢。

   權杖清單隨即出現。

2. 選取權杖或配方。

   權杖或配方隨即出現在 [指定查詢] 欄位中。

   網頁瀏覽器的網址列會更新，顯示您在 [指定查詢] 欄位中進行的變更。 如果您或其他使用者稍後要繼續編輯查詢，請複製並儲存此 URL。

3. 使用可用的權杖完成查詢。
4. 按一下 [格式及裝載選項] 自訂資料的格式。

   選取排序方法、要傳回的項目數，以及資料的格式。

5. (選用) 按一下 [執行] 按鈕。

   OpenAPI 便會執行查詢，而且結果會以您選取的格式顯示。

6. 按一下 [複製 ()] 按鈕。

   查詢 URL 隨即複製到剪貼簿，而且可以在網頁瀏覽器或 REST 工具中貼上。

   所有 OpenAPI 查詢的基礎 URL 如下：

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

重要：傳回大量結果的查詢會對系統造成負面影響。 建議您精簡查詢，只傳回與您的需求相關的結果。