この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

RestResponse クラス

Apex RESTful Web サービスメソッドから HTTP 応答にデータを渡す場合に使用されるオブジェクトを表します。

名前空間

System

使用方法

System.RestResponse クラスを使用して、REST アノテーションの 1 つを使用して定義される Apex RESTful Web サービスメソッドの応答データを渡します。

RestResponse のコンストラ��ター

RestResponse のコンストラクターは次のとおりです。

RestResponse()

System.RestResponse クラスの新しいインスタンスを作成します。

署名

public RestResponse()

RestResponse のプロパティ

RestResponse のプロパティは次のとおりです。

RestResponse List プロパティと Map プロパティは参照専用ですが、内容は参照・更新が可能です。変更するには、Collection メソッドを直接コールするか、前の表に示した、関連付けられた RestResponse メソッドを使用できます。

メモ

responseBody

レスポンスボディを返すか、設定します。

署名

public Blob responseBody {get; set;}

プロパティ値

型: Blob

使用方法

応答は、メソッドの戻り値のシリアライズされた形式、または、次のルールに基づいた responseBody ��ロパティの値です。

  • メソッドが void を返す場合、Apex REST は、responseBody プロパティの応答を返します。
  • メソッドが値を返す場合、Apex REST は、戻り値を応答としてシリアライズします。戻り値に null 値の項目が含まれる場合、これらの項目は応答でシリアライズされません。

headers

応答に送信されるヘッダーを返します。

署名

public Map<String, String> headers {get; set;}

プロパティ値

型: Map<String, String>

statusCode

応答状況コードを返すか、設定します。

署名

public Integer statuscode {get; set;}

プロパティ値

型: Integer

状況コード

次に、有効な応答状況コードを示します。状況コードは、RestResponse.statusCode プロパティから返されます。

RestResponse.statusCode プロパティを表に示されていない値に設定した場合、HTTP 状況 500 とエラーメッセージ「Invalid status code for HTTP response: nnn」が返されます。nnn は無効な状況コード値です。

メモ

状況コード 説明
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

RestResponse のメソッド

RestResponse のインスタンスメソッドを次に示します。

実行時に、ヘッダーは、対応するプロパティに自動的にデシリアライズされるため、通常 RestResponse オブジェクトに追加する必要はありません。次のメソッドは、Apex REST クラスをテストするユニットを対象とします。これらのメソッドを使用して、ヘッダーまたはパラメーター値を RestRequest オブジェクトに追加でき、REST メソッドコールを再作成する必要はありません。

メモ

addHeader(name, value)

応答ヘッダー対応付けにヘッダーを追加します。

署名

public Void addHeader(String name, String value)

パラメーター

name
型: String
value
型: String

戻り値

型: Void

使用方法

次のヘッダーは許可されていません。
  • Cookie
  • set-cookie
  • set-cookie2
  • content-length
  • authorization
  • RFC 7230 に準拠していないヘッダー名
これらのヘッダーのいずれかが使用された場合は Apex 例外が発生します。