---
sourceDocument: Référence de l’API Xanadu
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/fr-FR/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - fr-FR

ft:publication_title :

    - Référence de l’API Xanadu

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# RESTAPIRequest - Dans le champ d'application, Global

# RESTAPIRequest - Dans le champ d'application, Global {#ariaid-title1}

* Rversion finale: Xanadu
* 
* Mis à jour 1 août 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 minutes de lecture

L'API RESTAPIRequest fournit des méthodes qui vous permettent d'accéder aux détails des demandes d'API REST scriptées dans des 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 de l'API REST scriptés.

## RESTAPIRequest : corps {#ariaid-title2}

Corps de la demande.
{#r_SSR_body__table_a3m_rt1_sr__entry__3}

| Nom | Type | Description |
|-|-|-|
| body | [RESTAPIRequestBody](https://servicenow-prod.fluidtopics.net/EZ9sYYShL78VH6v7rAylcg#c_ScriptableServiceRequestBody "L’API RESTAPIRequestBody fournit des méthodes qui vous permettent d’accéder au contenu du corps d’une demande d’API REST scriptée dans des scripts.") | Corps de la demande. Vous pouvez accéder aux données de l'objet body à l'aide de l'API RESTAPIRequestBody. |
[Tableau 1. Champ]

{#r_SSR_body__table_a3m_rt1_sr}  

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

## RESTAPIRequest : getHeader(en-tête de chaîne) {#ariaid-title3}

Renvoie la valeur d'un en-tête spécifique à partir de la demande de service Web.
{#r_SSR-getHeader_String__table_q32_q2r_qr__entry__3}

| Nom | Type | Description |
|-|-|-|
| header | Chaîne | Nom de l'en-tête, par accept exemple ou content-type. |
[Tableau 2. Paramètres]

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

| Type | Description |
|-|-|
| Chaîne | Valeur de l'en-tête spécifié. |
[Tableau 3. Renvoie]

{#r_SSR-getHeader_String__table_r32_q2r_qr}  

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

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

Obtenir les types de contenu spécifiés dans l'en-tête Accepter la demande.
{#r_SSR-getSupportedRespContentTypes__table_rtm_qg3_zs__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun |   |   |
[Tableau 4. Paramètres]

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

| Type | Description |
|-|-|
| Tableau | Tableau de valeurs de chaîne où chaque chaîne est un type de contenu, tel que application/json. |
[Tableau 5. Renvoie]

{#r_SSR-getSupportedRespContentTypes__table_stm_qg3_zs}

## RESTAPIRequest : en-têtes {#ariaid-title5}

Tous les en-têtes de la demande.
{#r_SSR_headers__table_zmm_3s1_sr__entry__3}

| Nom | Type | Description |
|-|-|-|
| en-têtes | objet | Tous les en-têtes de la demande et leurs valeurs. |
[Tableau 6. Champ]

{#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}

Les paramètres de chemin d'accès transmis dans l'URI de la demande.
{#r_SSR_pathParams__table_zsf_jr1_sr__entry__3}

| Nom | Type | Description |
|-|-|-|
| pathParams | Objet | Les paramètres de 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. |
[Tableau 7. Champ]

{#r_SSR_pathParams__table_zsf_jr1_sr}  
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 {#ariaid-title7}

Les paramètres de requête de la demande de service web.
{#r_SSR_queryParams__table_gzw_yg5_rr__entry__3}

| Nom | Type | Description |
|-|-|-|
| queryParams | Tableau | Les paramètres de requête de la demande de service web. |
[Tableau 8. Champ]

{#r_SSR_queryParams__table_gzw_yg5_rr}  
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 {#ariaid-title8}

Requête entière ajoutée à l'URI du point de terminaison.
{#r_SSR_queryString__table_zwx_5q1_sr__entry__3}

| Nom | Type | Description |
|-|-|-|
| Chaîne de requête | Chaîne | L'intégralité de la requête pour la demande. |
[Tableau 9. Champ]

{#r_SSR_queryString__table_zwx_5q1_sr}  
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 {#ariaid-title9}

L'URI de la demande, à l'exclusion des informations sur le domaine.
{#r_SSR_uri__table_h5d_ct1_sr__entry__3}

| Nom | Type | Description |
|-|-|-|
| uri | Chaîne | L'URI de la demande, à l'exclusion des informations sur le domaine. |
[Tableau 10. Champ]

{#r_SSR_uri__table_h5d_ct1_sr}  
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 {#ariaid-title10}

L'URL complète de la demande.
{#r_SSR_url__table_zdq_qs1_sr__entry__3}

| Nom | Type | Description |
|-|-|-|
| URL | Chaîne | L'URL complète de la demande. |
[Tableau 11. Champ]

{#r_SSR_url__table_zdq_qs1_sr}  
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"