サポートされているHTTPメソッド
最も一般的に使用されるHTTPメソッド(または動詞)は、GET
, POST
, PATCH
およびDELETE
です。 REST APIの構成要素であるこれらのメソッドは、URLを使用してRESTリソースに適用されるアクションを定義します。
ノート:
通常、子リソースは親リソースからセキュリティ権限を継承します。 したがって、子リソースでメソッドを使用するには、そのメソッドを親リソースで使用するためのアクセス権が必要です。 ただし、異なる権限要件を持つ子リソースにアクセスする場合もあります。次の表に、単一のリソースおよび収集リソースのメソッドとそのスコープを示します。
メソッド | 単一リソースで機能しますか。 | コレクション・リソースで機能しますか。 |
---|---|---|
GET |
はい。 単一のリソースを取得します。 | はい。 コレクション内のサブセットまたはすべてのリソースを取得します。 |
POST |
はい。 単一のリソースを作成します。 | はい。 コレクションに新しいリソースを作成します。 |
PUT |
はい。 リソースを更新します。 | いいえ。 |
PATCH |
はい。 リソースに関連するオブジェクトを置き換えます。 | いいえ。 |
DELETE |
はい。 リソースを削除します。 | いいえ。 |
OPTIONS |
はい。 リソースでサポートされているメソッドを取得します。 | いいえ。 |
GETメソッド
このメソッドは、リソース情報の問合せと取得に使用します。 単一のリソースとコレクション・リソースの両方を問い合せるには、問合せパラメータを使用します。 問合せ結果にフィルタを適用するには、単一のリソースとコレクション・リソースに異なるパラメータを使用します。 詳細は、「回収の管理」を参照してください。 次のメディア・タイプとこのメソッドを使用して、リクエストします:
- リソースまたはリソースの集合:
application/json
application/xml
- リソースのカタログ情報:
application/json
- リソースのカタログ・スキーマ情報:
application/schema+json
POSTメソッド
新しいリソースを作成するために使用します。 このメソッドで使用できるメディア・タイプは、application/json
およびapplication/xml.
です
PUTメソッド
リソースの更新に使用します。 このメソッドで使用できるメディア・タイプは、application/json
およびapplication/xml.
です
PATCHメソッド
リソースに関連するオブジェクトを置換する場合に使用します。 このメソッドで使用できるメディア・タイプは、application/json
およびapplication/xml.
です
DELETEメソッド
リソースを削除するために使用します。 このリクエスト・メソッドにはリクエスト本文は必要ありません。
OPTIONSメソッド
リソースに使用可能なHTTPメソッドを検索するために使用します。 このメソッドで使用できるメディア・タイプは、application/json
のみです。 このリクエスト・メソッドにはリクエスト本文は必要ありません。