HTTP リクエストメソッド
モジュールでAPI呼び出しを設定する場合は、HTTP リクエストメソッドを選択する必要があります。 この記事では、使用可能な方法と、それぞれの方法を選択する理由について説明します。
HTTP メソッド
次のいずれかの HTTP メソッドを使用します。
- GET:パラメーターに基づいて web サーバーからデータを取得します。 GET は、指定されたリソースの表現をリクエストし、成功した場合は、リクエストされたコンテンツを含む 200 OK 応答メッセージを受け取ります。
- POST:パラメーターに基づいて web サーバーにデータを送信します。 POST リクエストには、ファイルのアップロードなどのアクションが含まれます。 複数のPOSTsは、単一のPOSTとは異なる結果になる可能性があるため、複数のPOSTを誤って送信する場合には注意が必要です。 POSTが成功した場合、200 OKの応答メッセージが表示されます。
- PUT:パラメーターに基づいて web サーバー内の場所にデータを送信します。 PUT リクエストには、ファイルのアップロードなどのアクションが含まれます。 PUTとPOSTの違いは、PUTが等電位であることです。つまり、1回のPUTPUTが成功した結果は、同一の多くのPUTと同じです。 PUTが成功すると、200の応答メッセージ(通常は201または204)が表示されます。
- PATCH:(一部の API 呼び出しモジュールでは使用不可)パラメーターに基づいて web サーバー上のリソースに部分的な変更を適用します。 PATCH はべき等ではなく、複数の PATCH の結果は意図しない影響をもたらす可能性があります。 PATCH が成功した場合は、200 応答メッセージ(通常は 204)を受け取ります。
- DELETE:パラメーター(リソースが存在する場合)に基づいて、指定したリソースを web サーバーから削除します。 DELETE が成功した場合は、200 OK メッセージを受け取ります。
recommendation-more-help
workfront-fusion-help-workfront-fusion