リソース
Version 23.0.8844
リソース
Version 23.0.8844
リソースはAPI で公開されているオブジェクトで、クエリ、作成、更新、および削除が可能です。リソースは、作成、読み出し、更新、および削除(CRUD)操作の全範囲をサポートすることも、一部のみに限定することもできます。このセクションでは、API Server によって公開されているリソースに対してCRUD 操作を実行するために使用されるHTTP メソッドについて説明します。
GET
HTTP GET リクエストは、サーバーからリソースまたはリソースセットを取得する場合に使用します。以下は、コレクション全体に対するリクエストの例です。
GET http://MyServer:MyPort/api.rsc/Cars
以下は対応するレスポンスです。
{
"@odata.context": "http://MyServer:MyPort/api.rsc/$metadata#Cars",
"value": [
{ "Id": "Id_1", "Color": "Color_1", "Model": "Model_1"},
{ "Id": "Id_2", "Color": "Color_2", "Model": "Model_2"},
{ "Id": "Id_3", "Color": "Color_3", "Model": "Model_3"}
]
}
POST
HTTP POST リクエストは、リソース内に新規リソースを作成する場合に使用します。リクエストは、新しいリソースを作成するために必要なインプットを含んでいなければなりません。次にリクエストの例を示します。
POST http://MyServer:MyPort/api.rsc/Cars
{
"Color": "Color_1", "Model": "Model_1"
}
以下は対応するレスポンスです。
{
"@odata.context":"http://MyServer:MyPort/api.rsc/$metadata#Cars",
"value": [
{
"Id": "1000",
"Color": "Color_1",
"Model": "Model_2"
}]
}
PUT
HTTP PUT リクエストは、リソースを更新する場合に使用します。主キーが必要です。次にリクエストの例を示します。
PUT http://MyServer:MyPort/api.rsc/Cars('Id_1')
{
"Color": "Color_1", "Model": "Model_1"
}
以下は対応するレスポンスです。
{
"@odata.context":"http://MyServer:MyPort/api.rsc/$metadata#Cars/$entity",
"Id": "Id_1",
"Color": "Color_1",
"Model": "Model_1"
}
DELETE
HTTP DELETE リクエストは、リソースを削除する場合に使用します。主キーが必要です。次にリクエストの例を示します。
DELETE http://MyServer:MyPort/api.rsc/Cars/('Id_1')
レスポンスは空で、”204 No Content” HTTP ステータス行が表示されます。
HTTP メソッドのオーバーライド
クライアントのいくつかは、特定の処理のための正しいHTTP メソッドを発行することができないかもしれません。@x-http-method クエリ文字列入力パラメータを使う、もしくはHTTP ヘッダーX-HTTP-Method
を使うことで、リクエストのHTTP メソッドをオーバーライドすることができます。例えば、HTTP-PUT をサポートしていないクライアントは、リソースに対する更新リクエストを発行するために、GET リクエストとともに_X-HTTP-Method: PUT_ ヘッダーを含めることができます。