RESTAPIRequest : champ d’application, global

L’API RESTAPIRequest fournit des méthodes qui vous permettent d’accéder aux détails des demandes de l’API REST scriptées dans les scripts.

Cette API s’exécute dans l’espace de noms sn_ws .

Remarque :

Vous ne pouvez pas instancier des objets de ce type. Les objets de ce type sont créés automatiquement et ne sont accessibles que dans les scripts de ressources d’API REST scriptés.

RESTAPIRequest : corps

Le corps de la demande.

Tableau 1. Champ

Nom	Type	Description
body	RESTAPIRequestBody	Le corps de la demande. Vous pouvez accéder aux données de l’objet body à l’aide de l’API RESTAPIRequestBody.

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

RESTAPIRequest : getHeader(en-tête de chaîne)

Renvoie la valeur d’un en-tête spécifique à partir de la demande de service web.

Tableau 2. Paramètres

Nom	Type	Description
header	Chaîne	Nom de l’en-tête, par exemple ou acceptcontent-type.

Tableau 3. Renvoie

Type	Description
Chaîne	Valeur de l’en-tête spécifié.

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

RESTAPIRequest : getSupportedResponseContentTypes()

Obtenir les types de contenu spécifiés dans l’en-tête Accepter de la demande.

Tableau 4. Paramètres

Nom	Type	Description
Aucun

Tableau 5. Renvoie

Type	Description
Tableau	Tableau de valeurs de chaîne où chaque chaîne est un type de contenu, tel que application/json.

RESTAPIRequest : en-têtes

Tous les en-têtes de la demande.

Tableau 6. Champ

Nom	Type	Description
en-têtes	objet	Tous les en-têtes de la demande et leurs valeurs.

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

RESTAPIRequest : pathParams

Paramètres de chemin d’accès transmis dans l’URI de la demande.

Tableau 7. Champ

Nom	Type	Description
pathParams	Objet	Les paramètres du chemin d’accès en tant qu’objet de script. Les paramètres de chemin d’accès disponibles dépendent de la configuration du service web.

Dans cet exemple, le point de terminaison de l’API REST scripté suit le format suivant : https://instance.service-now.com/api/now/myservice/{tableName}/{id}. La demande en cours de traitement utilise cette 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

Paramètres de requête de la demande de service web.

Tableau 8. Champ

Nom	Type	Description
queryParams	Tableau	Paramètres de requête de la demande de service web.

Dans cet exemple, la demande en cours de traitement utilise cette URL : https://<instance_rest_endpoint> ?active=false&name=now. Notez les active paramètres et name .

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

RESTAPIRequest : queryString

Requête entière ajoutée à l’URI du point de terminaison.

Tableau 9. Champ

Nom	Type	Description
chaîne de requête	Chaîne	Toute la requête pour la demande.

Dans cet exemple, la demande en cours de traitement utilise cette URL : https://<instance_rest_endpoint> ?active=false&name=now. Notez la requête active=false&name=now.

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

RESTAPIRequest : uri

L’URI de la demande, à l’exclusion des informations de domaine.

Tableau 10. Champ

Nom	Type	Description
uri	Chaîne	L’URI de la demande, à l’exclusion des informations de domaine.

Dans cet exemple, la demande en cours de traitement utilise cette 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 complète de la demande.

Tableau 11. Champ

Nom	Type	Description
URL	Chaîne	URL complète de la demande.

Dans cet exemple, la demande en cours de traitement utilise cette 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"