RESTAPIRequest – Bereichsbezogen, Global

Die RESTAPIRequest -API stellt Methoden bereit, mit denen Sie in Skripts auf geskriptete REST-API-Anforderungsdetails zugreifen können.

Diese API wird im Namespace sn_ws ausgeführt.

Hinweis:

Sie können Objekte dieses Typs nicht instanziieren. Objekte dieses Typs werden automatisch erstellt und sind nur in Skripts für geskriptete REST-API-Ressourcen verfügbar.

RESTAPIRequest – body

Der Textkörper der Anforderung.

Tabelle : 1. Feld

Name	Typ	Beschreibung
body	RESTAPIRequestBody	Der Textkörper der Anforderung. Sie können über die RESTAPIRequestBody-API auf Daten aus dem body-Objekt zugreifen.

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

RESTAPIRequest – getHeader(String header)

Gibt den Wert einer bestimmten Kopfzeile aus der Webservice-Anforderung zurück.

Tabelle : 2. Parameter

Name	Typ	Beschreibung
header	Zeichenfolge	Der Name des Headers, z. B. accept oder content-type.

Tabelle : 3. Ergebnisse

Typ	Beschreibung
Zeichenfolge	Der Wert der angegebenen Kopfzeile.

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

RESTAPIRequest – getSupportedResponseContentTypes()

Ruft die Content-Typen ab, die in der Anforderungskopfzeile „Accept“ angegeben sind.

Tabelle : 4. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 5. Ergebnisse

Typ	Beschreibung
Array	Ein Array von Zeichenfolgenwerte, wobei jeder String ein Content-Typ ist, z. B. „application/json“.

RESTAPIRequest – headers

Alle Kopfzeilen aus der Anforderung.

Tabelle : 6. Feld

Name	Typ	Beschreibung
headers	object	Alle Kopfzeilen der Anforderung und ihre Werte.

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

RESTAPIRequest – pathParams

Die im Anforderungs-URI übergebenen Pfadparameter.

Tabelle : 7. Feld

Name	Typ	Beschreibung
pathParams	Objekt	Die Pfadparameter als Skriptobjekt. Die verfügbaren Pfadparameter hängen von der Webservice-Konfiguration ab.

In diesem Beispiel hat der geskriptete REST-API-Endpunkt folgendes Format: https://instance.service-now.com/api/now/myservice/{tableName}/{id}. Die verarbeitete Anforderung verwendet diese URL: https://instance.service-now.com/api/now/myservice/myApp_table/1234.

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

RESTAPIRequest - queryParams

Die Abfrageparameter aus der Webservice-Anforderung.

Tabelle : 8. Feld

Name	Typ	Beschreibung
queryParams	Array	Die Abfrageparameter aus der Webservice-Anforderung.

In diesem Beispiel verwendet die verarbeitete Anforderung diese URL: https://<instance_rest_endpoint>?active=false&name=now. Beachten Sie die Parameter active und name.

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

RESTAPIRequest – queryString

Die gesamte Abfrage, die dem Endpunkt-URI hinzugefügt wurde.

Tabelle : 9. Feld

Name	Typ	Beschreibung
queryString	Zeichenfolge	Die gesamte Abfrage für die Anforderung.

In diesem Beispiel verwendet die verarbeitete Anforderung diese URL: https://<instance_rest_endpoint>?active=false&name=now. Beachten Sie die Abfrage active=false&name=now.

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

RESTAPIRequest – uri

Der Anforderungs-URI ohne Domäneninformationen.

Tabelle : 10. Feld

Name	Typ	Beschreibung
uri	Zeichenfolge	Der Anforderungs-URI ohne Domäneninformationen.

In diesem Beispiel verwendet die verarbeitete Anforderung diese URL: https://instance.service-now.com/api/now/table/myTable?active=false&name=now.

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

RESTAPIRequest – url

Die gesamte Anforderungs-URL.

Tabelle : 11. Feld

Name	Typ	Beschreibung
URL	Zeichenfolge	Die gesamte Anforderungs-URL.

In diesem Beispiel verwendet die verarbeitete Anforderung diese 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"