API要求の実行

Swaggerのユーザ インターフェイスでは、各API処理に関する詳細情報とドキュメントを参照できます。

開始する前に

注意:API Docs Webページを使用して実行するAPI処理はすべてその場で実行されます。設定データやその他のデータを誤って作成、更新、または削除しないように注意してください。

手順

  1. Grid Managerヘッダーから[Help] > [API Documentation]を選択します。
  2. 目的の処理を選択します。

    API処理を展開すると、使用可能なHTTPアクション(GET、PUT、UPDATE、DELETEなど)が表示されます。

  3. HTTPアクションを選択して、要求の詳細(エンドポイントURL、必須またはオプションのパラメータのリスト、必要な場合は要求の本文の例、想定される応答)を確認します。

    Swagger UIの例
  4. グループやユーザのIDなど、要求で追加のパラメータが必要かどうかを確認します。次に、それらの値を取得します。必要な情報を取得するために、先に別のAPI要求の実行が必要な場合もあります。
  5. 要求の本文の例を変更する必要があるかどうかを確認します。変更する場合は、[Model]をクリックすると各フィールドの要件を確認できます。
  6. [Try it out]をクリックします。
  7. 必須パラメータを指定するか、必要に応じて要求の本文を変更します。
  8. [Execute]をクリックします。
  9. 応答コードをチェックし、要求が正常に完了したかどうかを確認します。