HTTP 応答本文

言語:

すべての応答データは、RFC 4627 で定義された JSON 形式でエンコードされます。ほかに指定がないかぎり、単一のリソースに対するコマンドは、プロパティーとしてリソース名を持つ単一の JSON 結果オブジェクトを返します。各コマンドセクションでは、この JSON 結果オブジェクトで返されるプロパティー名を示しています。

ほかに記述がないかぎり、作成 (POST) および変更 (PUT) コマンドは、作成または変更されたリソースのプロパティーを返します。内容は GET リクエストによって返される値と一致します。

本文の例:

{
    "resource_name": {
        "href": "path/to/this/resource",
        "property_01": "value_01",
        "property_02": "value_01
    }
}

一部の GET コマンドはリソースのリストを返します。

{
    "resource_list_name": [
        {
            "href": "path/to/resource_01",
            "property_01": "value_01"
        }, {
            "href": "path/to/resource_02",
            "property_02", "value_02"
        }
    ]
}

注 - このドキュメント全体で、コマンドでは、読みやすくするために改行とスペースを追加して書式設定された JSON 戻り結果を示しています。実際の出力ではこの書式設定が含まれません。