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

RESTAPIRequest API は、スクリプト化された REST API 要求の詳細にスクリプトでアクセスできるメソッドを提供します。

この API は sn_ws 名前空間で実行されます。

注:

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

RESTAPIRequest - body

要求の本文。

表 : 1. フィールド

名前	タイプ	説明
本文	RESTAPIRequestBody	要求の本文。RESTAPIRequestBody API を使用して、本文オブジェクトからデータにアクセスできます。

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

RESTAPIRequest - getHeader(文字列 header)

Web サービス要求から特定のヘッダーの値を返します。

表 : 2. パラメーター

名前	タイプ	説明
header	文字列	ヘッダーの名前 (accept や content-typeなど)。

表 : 3. 返される内容

タイプ	説明
文字列	指定されたヘッダーの値。

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

RESTAPIRequest - getSupportedResponseContentTypes()

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

表 : 4. パラメーター

名前	タイプ	説明
なし

表 : 5. 返される内容

タイプ	説明
アレイ	各文字列がコンテンツタイプである文字列値のアレイ (application/json など)。

RESTAPIRequest - headers

要求のすべてのヘッダー。

表 : 6. フィールド

名前	タイプ	説明
headers	オブジェクト	要求のすべてのヘッダーとその値。

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

RESTAPIRequest - pathParams

要求 URI で渡されるパスパラメーター。

表 : 7. フィールド

名前	タイプ	説明
pathParams	オブジェクト	スクリプトオブジェクトとしてのパスパラメーター。使用可能なパスパラメーターは、Web サービスの構成によって異なります。

この例では、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

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

表 : 8. フィールド

名前	タイプ	説明
queryParams	アレイ	Web サービス要求からのクエリパラメーター。

この例では、処理される要求はこの 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

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

表 : 9. フィールド

名前	タイプ	説明
queryString	文字列	リクエストに対するクエリー全体。

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

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

RESTAPIRequest - uri

ドメイン情報を除いた要求 URI。

表 : 10. フィールド

名前	タイプ	説明
URI	文字列	ドメイン情報を除いた要求 URI。

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

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

RESTAPIRequest - url

要求 URL の全体。

表 : 11. フィールド

名前	タイプ	説明
url	文字列	要求 URL の全体。

この例では、処理される要求は 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"