---
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


---

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

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

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

RESTAPIRequest API には、スクリプト内のスクリプト化された REST API 要求の詳細にアクセスできるメソッドが用意されています。

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

## RESTAPIRequest - body {#ariaid-title2}

要求の本文。
{#r_SSR_body__table_a3m_rt1_sr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| 本文 | [RESTAPIRequestBody](https://servicenow-prod.fluidtopics.net/_u91nC6GB~1Hmt1BifC8pw#c_ScriptableServiceRequestBody "RESTAPIRequestBody API は、スクリプト内のスクリプト化された REST API 要求の本文コンテンツにアクセスできるメソッドを提供します。") | 要求の本文。RESTAPIRequestBody API を使用して、本文オブジェクトからデータにアクセスできます。 |
[表 : 1. フィールド]

{#r_SSR_body__table_a3m_rt1_sr}  

    var requestBody = request.body // Returns instance of RESTAPIRequestBody

## RESTAPIRequest - getHeader(文字列 header) {#ariaid-title3}

Web サービス要求から特定のヘッダーの値を返します。
{#r_SSR-getHeader_String__table_q32_q2r_qr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| header | 文字列 | ヘッダーの名前 (accept や content-typeなど)。 |
[表 : 2. パラメーター]

{#r_SSR-getHeader_String__table_q32_q2r_qr} {#r_SSR-getHeader_String__table_r32_q2r_qr__entry__2}

| タイプ | 説明 |
|-|-|
| 文字列 | 指定されたヘッダーの値。 |
[表 : 3. 返される内容]

{#r_SSR-getHeader_String__table_r32_q2r_qr}  

    var acceptHeader = request.getHeader('accept');

## RESTAPIRequest - getSupportedResponseContentTypes() {#ariaid-title4}

要求の \[受け入れ\] ヘッダーで指定されたコンテンツタイプを取得します。
{#r_SSR-getSupportedRespContentTypes__table_rtm_qg3_zs__entry__3}

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

{#r_SSR-getSupportedRespContentTypes__table_rtm_qg3_zs} {#r_SSR-getSupportedRespContentTypes__table_stm_qg3_zs__entry__2}

| タイプ | 説明 |
|-|-|
| アレイ | 各文字列がコンテンツタイプである文字列値のアレイ (application/json など)。 |
[表 : 5. 返される内容]

{#r_SSR-getSupportedRespContentTypes__table_stm_qg3_zs}

## RESTAPIRequest - headers {#ariaid-title5}

要求のすべてのヘッダー。
{#r_SSR_headers__table_zmm_3s1_sr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| headers | オブジェクト | 要求のすべてのヘッダーとその値。 |
[表 : 6. フィールド]

{#r_SSR_headers__table_zmm_3s1_sr}  

    var headers = request.headers; 
    var acceptHeader = headers.Accept;
    var myCustomHeader = headers.myCustom; 
    var specialHeader = headers['special - header'];

## RESTAPIRequest - pathParams {#ariaid-title6}

要求 URI で渡されるパスパラメーター。
{#r_SSR_pathParams__table_zsf_jr1_sr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| pathParams | オブジェクト | スクリプトオブジェクトとしてのパスパラメーター。使用可能なパスパラメーターは、Web サービスの構成によって異なります。 |
[表 : 7. フィールド]

{#r_SSR_pathParams__table_zsf_jr1_sr}  
この例では、Scripted REST API のエンドポイントが https://instance.service-now.com/api/now/myservice/{tableName}/{id} の形式に従って設定されます。処理中の要求は、https://instance.service-now.com/api/now/myservice/myApp_table/1234 という URL を使用します。

    var pathParams = request.pathParams; 
    var tableName = pathParams.tableName; //'myApp_table' 
    var id = pathParams.id; //'1234'

## RESTAPIRequest - queryParams {#ariaid-title7}

Web サービス要求からのクエリパラメーター。
{#r_SSR_queryParams__table_gzw_yg5_rr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| queryParams | アレイ | Web サービス要求からのクエリパラメーター。 |
[表 : 8. フィールド]

{#r_SSR_queryParams__table_gzw_yg5_rr}  
この例では、処理される要求はこの URL (https://\<instance_rest_endpoint\>?active=false\&name=now) を使用します。active および name パラメーターに注意してください。

    var queryParams = request.queryParams; 
    var isActiveQuery = queryParams.active; // [false] 
    var nameQueryVal = queryParams.name; // ['now']

## RESTAPIRequest - queryString {#ariaid-title8}

エンドポイント URI に追加されたクエリー全体。
{#r_SSR_queryString__table_zwx_5q1_sr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| queryString | 文字列 | リクエストに対するクエリー全体。 |
[表 : 9. フィールド]

{#r_SSR_queryString__table_zwx_5q1_sr}  
この例では、処理される要求は https://\<instance_rest_endpoint\>?active=false\&name=now という URL を使用します。`active=false&name=now` というクエリーに注意してください。

    var query = request.queryString; //"active=false&name=now"

## RESTAPIRequest - uri {#ariaid-title9}

ドメイン情報を除いた要求 URI。
{#r_SSR_uri__table_h5d_ct1_sr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| URI | 文字列 | ドメイン情報を除いた要求 URI。 |
[表 : 10. フィールド]

{#r_SSR_uri__table_h5d_ct1_sr}  
この例では、処理される要求は https://instance.service-now.com/api/now/table/myTable?active=false\&name=now という URL を使用します。

    var query = request.uri; //"api/now/table/myTable"

## RESTAPIRequest - url {#ariaid-title10}

要求 URL の全体。
{#r_SSR_url__table_zdq_qs1_sr__entry__3}

| 名前 | タイプ | 説明 |
|-|-|-|
| url | 文字列 | 要求 URL の全体。 |
[表 : 11. フィールド]

{#r_SSR_url__table_zdq_qs1_sr}  
この例では、処理される要求は https://instance.service-now.com/api/now/table/myTable?active=false\&name=now という URL を使用します。

    var query = request.url; //"https://instance.service-now.com/api/now/table/myTable?active=false&name=now"