RestResponse クラス
名前空間
使用方法
System.RestResponse クラスを使用して、REST アノテーションの 1 つを使用して定義される Apex RESTful Web サービスメソッドの応答データを渡します。
RestResponse のプロパティ
RestResponse のプロパティは次のとおりです。
responseBody
レスポンスボディを返すか、設定します。
署名
public Blob responseBody {get; set;}
プロパティ値
型: Blob
使用方法
応答は、メソッドの戻り値のシリアライズされた形式、または、次のルールに基づいた responseBody プロパティの値です。
- メソッドが void を返す場合、Apex REST は、responseBody プロパティの応答を返します。
- メソッドが値を返す場合、Apex REST は、戻り値を応答としてシリアライズします。戻り値に null 値の項目が含まれる場合、これらの項目は応答でシリアライズされません。
statusCode
応答状況コードを返すか、設定します。
署名
public Integer statuscode {get; set;}
プロパティ値
型: Integer
状況コード
次に、有効な応答状況コードを示します。状況コードは、RestResponse.statusCode プロパティから返されます。
| 状況コード | 説明 |
|---|---|
| 200 | OK |
| 201 | CREATED |
| 202 | ACCEPTED |
| 204 | NO_CONTENT |
| 206 | PARTIAL_CONTENT |
| 300 | MULTIPLE_CHOICES |
| 301 | MOVED_PERMANENTLY |
| 302 | FOUND |
| 304 | NOT_MODIFIED |
| 400 | BAD_REQUEST |
| 401 | UNAUTHORIZED |
| 403 | FORBIDDEN |
| 404 | NOT_FOUND |
| 405 | METHOD_NOT_ALLOWED |
| 406 | NOT_ACCEPTABLE |
| 409 | CONFLICT |
| 410 | GONE |
| 412 | PRECONDITION_FAILED |
| 413 | REQUEST_ENTITY_TOO_LARGE |
| 414 | REQUEST_URI_TOO_LARGE |
| 415 | UNSUPPORTED_MEDIA_TYPE |
| 417 | EXPECTATION_FAILED |
| 500 | INTERNAL_SERVER_ERROR |
| 503 | SERVER_UNAVAILABLE |