---
sourceDocument: Xanadu API リファレンス
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/ja-JP/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - ja-JP

ft:publication_title :

    - Xanadu API リファレンス

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# RESTAPIResponse - スコープ対象、グローバル

# RESTAPIResponse - スコープ対象、グローバル {#ariaid-title1}

* リリースバージョン: Xanadu
* 
* 更新日 2024年08月01日
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 所要時間：5分

RESTAPIResponse API は、スクリプト化された REST API 要求に対する RESTful 応答を作成できるメソッドを提供します。

この API は `sn_ws` 名前空間で実行されます。  
注:  
このタイプのオブジェクトはインスタンス化できません。このタイプのオブジェクトは自動的に作成され、Scripted REST API リソーススクリプトでのみアクセスできます。

## RESTAPIResponse - getStreamWriter() {#ariaid-title2}

この応答の ResponseStreamWriter を返します。それによって、応答ストリームに直接書き込むことができます。
setHeaders および setStatus 関数を使用してコンテンツタイプとステータスコードを設定してから、getStreamwriter 関数を呼び出します。
{#r_SSRB-getStreamWriter__table_wnn_glb_sr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし |   |   |
[表 : 1. パラメーター]

{#r_SSRB-getStreamWriter__table_wnn_glb_sr} {#r_SSRB-getStreamWriter__table_xnn_glb_sr__entry__2}

| タイプ | 説明 |
|-|-|
| RESTAPIResponseStream - スコープ対象、グローバル | この応答の ResponseStreamWriter。このオブジェクトを使用して、応答ストリームに直接書き込むことができます。 |
[表 : 2. 返される内容]

{#r_SSRB-getStreamWriter__table_xnn_glb_sr}  

    response.setContentType('application/json');
    response.setStatus(200);
    var writer = response.getStreamWriter();

## RESTAPIResponse - setBody(オブジェクト body) {#ariaid-title3}

Web サービス応答で送信する本文のコンテンツを設定します。
{#r_SSRB-setBody_Object__table_yzt_cmr_qr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| body | オブジェクト | JavaScript オブジェクトとしての応答の本文。 本文のコンテンツは、要求で渡された Accept ヘッダーの値に応じて JSON または XML に自動的にシリアル化されます。 |
[表 : 3. パラメーター]

{#r_SSRB-setBody_Object__table_yzt_cmr_qr} {#r_SSRB-setBody_Object__table_zzt_cmr_qr__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 4. 返される内容]

{#r_SSRB-setBody_Object__table_zzt_cmr_qr}  

    var body = {};
    body.name = "incident";
    body.number = "1234";
    body.caller = {"id": "user1"};
    response.setBody(body);

    var bodyArray = [];
    var body = {};
    body.name = "incident";
    body.number = "1234";
    body.caller = {"id":"user1"};
    bodyArray.push(body);
    response.setBody(bodyArray);

## RESTAPIResponse - setContentType(文字列 contentType) {#ariaid-title4}

Web サービス応答の Content-Type ヘッダーに値を割り当てます。
応答を書き込む前に、応答のコンテンツタイプを設定する必要があります。コンテンツタイプは、要求の \[受け入れ\] ヘッダーの値に基づいて、文字列応答に対して自動的に設定されます。

無効なコンテンツタイプを設定すると、応答はデフォルトで JSON になります。コンテンツタイプを設定しないと、バイナリ応答の送信時にステータスコード 500 のエラーが発生します。

このヘッダーの詳細については、[W3 Content-Type ヘッダーに関するドキュメント](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17)を参照してください。
{#r_SSRB-setContentType_String__table_dcn_3lr_qr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| contentType | 文字列 | 応答本文のコンテンツタイプ (application/json など)。 |
[表 : 5. パラメーター]

{#r_SSRB-setContentType_String__table_dcn_3lr_qr} {#r_SSRB-setContentType_String__table_ecn_3lr_qr__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 6. 返される内容]

{#r_SSRB-setContentType_String__table_ecn_3lr_qr}  

    response.setContentType('application/json');

## RESTAPIResponse - setError(オブジェクト error) {#ariaid-title5}

エラーを返すように REST 応答を設定します。
{#r_SSRB-setError_O__table_apv_hb3_zs__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| error | オブジェクト | エラーオブジェクト。 使用できるエラー オブジェクトの種類の詳細については、「 [Scripted REST API の例 - スクリプトサンプル](https://servicenow-prod.fluidtopics.net/mhVpKQQOsrMSAD18fehqXA "これらの例は、Scripted REST API のさまざまなリソーススクリプトを作成する方法を示しています。")」を参照してください。 |
[表 : 7. パラメーター]

{#r_SSRB-setError_O__table_apv_hb3_zs} {#r_SSRB-setError_O__table_bpv_hb3_zs__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 8. 返される内容]

{#r_SSRB-setError_O__table_bpv_hb3_zs}  
次の例は、スクリプト化された REST リソース内からエラーを返す方法を示しています。

    var queryParams = request.queryParams;
    var userId = String(queryParams.user_id || '');
    var fileId = String(queryParams.file_id || '');
    if (!userId || !fileId){
      response.setError(new sn_ws_err.BadRequestError('Missing required parameters.'));
      return;
    }

## RESTAPIResponse - setHeader(文字列 header, 文字列 value) {#ariaid-title6}

REST サービス応答ヘッダーに値を割り当てます。
{#r_SSRB-setHeader_String_String__table_und_rt4_gs__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| header | 文字列 | 設定するヘッダー。 |
| value | 文字列 | 指定されたヘッダーに割り当てる値。 |
[表 : 9. パラメーター]

{#r_SSRB-setHeader_String_String__table_und_rt4_gs} {#r_SSRB-setHeader_String_String__table_vnd_rt4_gs__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 10. 返される内容]

{#r_SSRB-setHeader_String_String__table_vnd_rt4_gs}  

    response.setHeader("Location","<URI>");

## RESTAPIResponse - setHeaders(オブジェクト headers) {#ariaid-title7}

Web サービス応答のヘッダーを設定します。
{#r_SSRB-setHeaders_Object__table_slb_j3r_qr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| headers | オブジェクト | 各ヘッダーとそのヘッダーに割り当てる値をリストする JavaScript オブジェクト。 |
[表 : 11. パラメーター]

{#r_SSRB-setHeaders_Object__table_slb_j3r_qr} {#r_SSRB-setHeaders_Object__table_tlb_j3r_qr__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 12. 返される内容]

{#r_SSRB-setHeaders_Object__table_tlb_j3r_qr}  

    var headers = {};
    headers.X-Total-Count=100;
    headers.Location='https://instance.service-now.com/<endpoint_to_resource>';
    response.setHeaders(headers);

## RESTAPIResponse - setLocation(文字列 location) {#ariaid-title8}

Web サービス応答の Location ヘッダーに値を割り当てます。
このヘッダーの詳細については、[W3 Location ヘッダーに関するドキュメント](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30)を参照してください。
{#r_SSRB-setLocation_String__table_mzd_1jr_qr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| なし | 文字列 | 応答の受信者のリダイレクト先となる絶対 URI。 |
[表 : 13. パラメーター]

{#r_SSRB-setLocation_String__table_mzd_1jr_qr} {#r_SSRB-setLocation_String__table_nzd_1jr_qr__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 14. 返される内容]

{#r_SSRB-setLocation_String__table_nzd_1jr_qr}

## RESTAPIResponse - setStatus(数字 status) {#ariaid-title9}

Web サービス応答のステータスコード番号を設定します。
{#r_SSRB-setStatus_Number__table_tj5_khr_qr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| status | 数字 | 応答内で送信するステータスコード (成功を示す 200 など)。文字列などの数字でない値を渡すと、ステータスコードはデフォルトで 0 になります。 |
[表 : 15. パラメーター]

{#r_SSRB-setStatus_Number__table_tj5_khr_qr} {#r_SSRB-setStatus_Number__table_uj5_khr_qr__entry__2}

| タイプ | 説明 |
|-|-|
| なし |   |
[表 : 16. 返される内容]

{#r_SSRB-setStatus_Number__table_uj5_khr_qr}  

    response.setStatus(200);