RESTAPIRequest:スコープ指定、グローバル

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

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

注:

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

RESTAPIRequest:本文

要求の本文。

表 : 1. フィールド

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

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

RESTAPIRequest - getHeader(文字列ヘッダー)

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

表 : 2. パラメーター

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

表 : 3. 戻り値

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

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

RESTAPIRequest - getSupportedResponseContentTypes()

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

表 : 4. パラメーター

名前	タイプ	説明
なし

表 : 5. 戻り値

タイプ	説明
アレイ	文字列値のアレイ。各文字列は application/json などのコンテンツタイプです。

RESTAPIRequest:ヘッダー

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

表 : 6. フィールド

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

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

RESTAPIRequest:pathParams

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

表 : 7. フィールド

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

この例では、スクリプト化された 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 サービス要求からのクエリパラメーター。

この例では、処理中の要求で https://<instance_rest_endpoint>?active=false&name=now という URL を使用しています。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 (ドメイン情報を除く)。

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

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

RESTAPIRequest:url

要求 URL 全体。

表 : 11. フィールド

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

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

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