テーブルリソースへのアクセス
Version 25.3.9411
Version 25.3.9411
テーブルリソースへのアクセス
テーブルリソースは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"
}
Note:主キーは必須です。
対応するレスポンス
{
"@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')
Note:主キーは必須です。
対応するレスポンス
レスポンスは空で、 204 No Content HTTP ステータス行が表示されます。
HTTP メソッドのオーバーライド
一部のクライアントは、特定の処理のための正しいHTTP メソッドを発行できない場合があります。@x-http-method クエリ文字列入力パラメータを使う、もしくはHTTP ヘッダーX-HTTP-Method を使うことで、リクエストのHTTP メソッドをオーバーライドすることができます。例えば、HTTP PUT をサポートしていないクライアントは、テーブルに対する更新リクエストを発行するために、GET リクエストとともにX-HTTP-Method: PUT ヘッダーを含めることができます。