Skip to main content
日本語は機械翻訳による参考訳です。内容に矛盾や不一致があった場合には、英語の内容が優先されます。

API要求の実行

共同作成者
PDF

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

必要なもの

  • Grid Managerにはサポートされているブラウザを使用してサインインする必要があります。

  • 特定のアクセス権限が必要です。

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

  1. Grid Managerヘッダーから* Help > API Documentation *を選択します。

  2. 目的の処理を選択します。

    API 処理を拡張すると、 GET 、 PUT 、 UPDATE 、 DELETE など、使用可能な HTTP アクションを確認できます。

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

    Swagger UI の例

  4. グループやユーザの ID など、要求で追加のパラメータが必要かどうかを確認します。次に、これらの値を取得します。必要な情報を取得するために、先に別の API 要求の問題 が必要になることがあります。

  5. 要求の本文の例を変更する必要があるかどうかを判断します。その場合は、[*Model]をクリックして各フィールドの要件を確認できます。

  6. [* 試してみてください * ] をクリックします。

  7. 必要なパラメータを指定するか、必要に応じて要求の本文を変更します。

  8. [* Execute] をクリックします。

  9. 応答コードを確認し、要求が成功したかどうかを判断します。