---
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


---

# RESTAPIResponse - Inclus, Global

# RESTAPIResponse - Inclus, Global {#ariaid-title1}

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

L'API RESTAPIResponse fournit des méthodes qui vous permettent de créer une réponse RESTful à une demande d'API REST scriptée.

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.

## RESTAPIResponse : getStreamWriter() {#ariaid-title2}

Renvoie le ResponseStreamWriter pour cette réponse, ce qui vous permet d'écrire directement dans le flux de réponse.
Définissez le type de contenu et le code d'état à l'aide des fonctions setHeaders et setStatus avant d'appeler la fonction getStreamWriter .
{#r_SSRB-getStreamWriter__table_wnn_glb_sr__entry__3}

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

{#r_SSRB-getStreamWriter__table_wnn_glb_sr} {#r_SSRB-getStreamWriter__table_xnn_glb_sr__entry__2}

| Type | Description |
|-|-|
| RESTAPIResponseStream : champ d'application, global | Le ResponseStreamWriter pour cette réponse. Vous pouvez utiliser cet objet pour écrire directement dans le flux de réponse. |
[Tableau 2. Renvoie]

{#r_SSRB-getStreamWriter__table_xnn_glb_sr}  

    response.setContentType('application/json');
    response.setStatus(200);
    var writer = response.getStreamWriter();

## RESTAPIResponse - setBody(Corps de l'objet) {#ariaid-title3}

Définit le contenu du corps à envoyer dans la réponse de service web.
{#r_SSRB-setBody_Object__table_yzt_cmr_qr__entry__3}

| Nom | Type | Description |
|-|-|-|
| body | Objet | Le corps de la réponse, en tant qu'objet JavaScript. Le contenu du corps est automatiquement sérialisé en JSON ou XML en fonction de la valeur de l'en-tête Accept transmis dans la requête. |
[Tableau 3. Paramètres]

{#r_SSRB-setBody_Object__table_yzt_cmr_qr} {#r_SSRB-setBody_Object__table_zzt_cmr_qr__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 4. Renvoie]

{#r_SSRB-setBody_Object__table_zzt_cmr_qr}  

    var body = {};
    body.name = "incident";
    body.number = "1234";
    body.caller = {"id": "user1"};
    response.setBody(body);

    var bodyArray = [];
    var body = {};
    body.name = "incident";
    body.number = "1234";
    body.caller = {"id":"user1"};
    bodyArray.push(body);
    response.setBody(bodyArray);

## RESTAPIResponse : setContentType(String contentType) {#ariaid-title4}

Affecte une valeur à l'en-tête Type de contenu dans la réponse de service Web.
Vous devez définir un type de contenu de réponse avant de rédiger la réponse. Le type de contenu est défini automatiquement pour les réponses de chaîne, en fonction de la valeur de l'en-tête Accepter la demande.

Si vous définissez un type de contenu non valide, la réponse est définie par défaut sur JSON. L'échec de la définition d'un type de contenu entraîne une erreur de code d'état 500 lors de l'envoi d'une réponse binaire.

Consultez la [documentation de l'en-tête W3 Content-Type](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17) pour plus d'informations sur cet en-tête.
{#r_SSRB-setContentType_String__table_dcn_3lr_qr__entry__3}

| Nom | Type | Description |
|-|-|-|
| Type de contenu | Chaîne | Type de contenu du corps de la réponse, par exemple application/json. |
[Tableau 5. Paramètres]

{#r_SSRB-setContentType_String__table_dcn_3lr_qr} {#r_SSRB-setContentType_String__table_ecn_3lr_qr__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 6. Renvoie]

{#r_SSRB-setContentType_String__table_ecn_3lr_qr}  

    response.setContentType('application/json');

## RESTAPIResponse : setError(Object error) {#ariaid-title5}

Configure la réponse REST pour renvoyer une erreur.
{#r_SSRB-setError_O__table_apv_hb3_zs__entry__3}

| Nom | Type | Description |
|-|-|-|
| erreur | Objet | Objet d'erreur. Pour plus d'informations sur les types d'objets d'erreur pouvant être utilisés, reportez-vous à la section [Exemple d'API REST scriptée : exemples de scripts](https://servicenow-prod.fluidtopics.net/DHWUpolKh27JZZb2YiOFgA "Ces exemples montrent comment créer divers scripts de ressources pour une API REST scriptée."). |
[Tableau 7. Paramètres]

{#r_SSRB-setError_O__table_apv_hb3_zs} {#r_SSRB-setError_O__table_bpv_hb3_zs__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 8. Renvoie]

{#r_SSRB-setError_O__table_bpv_hb3_zs}  
L'exemple suivant montre comment renvoyer une erreur à partir d'une ressource REST scriptée.

    var queryParams = request.queryParams;
    var userId = String(queryParams.user_id || '');
    var fileId = String(queryParams.file_id || '');
    if (!userId || !fileId){
      response.setError(new sn_ws_err.BadRequestError('Missing required parameters.'));
      return;
    }

## RESTAPIResponse : setHeader(en-tête de chaîne, valeur de chaîne) {#ariaid-title6}

Affectez une valeur à un en-tête de réponse de service REST.
{#r_SSRB-setHeader_String_String__table_und_rt4_gs__entry__3}

| Nom | Type | Description |
|-|-|-|
| header | Chaîne | L'en-tête que vous souhaitez définir. |
| valide | Chaîne | Valeur permettant d'affecter l'en-tête spécifié. |
[Tableau 9. Paramètres]

{#r_SSRB-setHeader_String_String__table_und_rt4_gs} {#r_SSRB-setHeader_String_String__table_vnd_rt4_gs__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 10. Renvoie]

{#r_SSRB-setHeader_String_String__table_vnd_rt4_gs}  

    response.setHeader("Location","<URI>");

## RESTAPIResponse : setHeaders(en-têtes d'objets) {#ariaid-title7}

Définit les en-têtes de la réponse du service web.
{#r_SSRB-setHeaders_Object__table_slb_j3r_qr__entry__3}

| Nom | Type | Description |
|-|-|-|
| en-têtes | Objet | Objet JavaScript répertoriant chaque en-tête et la valeur pour affecter cet en-tête. |
[Tableau 11. Paramètres]

{#r_SSRB-setHeaders_Object__table_slb_j3r_qr} {#r_SSRB-setHeaders_Object__table_tlb_j3r_qr__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 12. Renvoie]

{#r_SSRB-setHeaders_Object__table_tlb_j3r_qr}  

    var headers = {};
    headers.X-Total-Count=100;
    headers.Location='https://instance.service-now.com/<endpoint_to_resource>';
    response.setHeaders(headers);

## RESTAPIResponse - setLocation(String location) {#ariaid-title8}

Affecte une valeur à l'en-tête Emplacement dans la réponse de service web.
Consultez la [documentation de l'en-tête d'emplacement W3](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30) pour plus d'informations sur cet en-tête.
{#r_SSRB-setLocation_String__table_mzd_1jr_qr__entry__3}

| Nom | Type | Description |
|-|-|-|
| Aucun | Chaîne | URI absolu vers lequel rediriger le destinataire de la réponse. |
[Tableau 13. Paramètres]

{#r_SSRB-setLocation_String__table_mzd_1jr_qr} {#r_SSRB-setLocation_String__table_nzd_1jr_qr__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 14. Renvoie]

{#r_SSRB-setLocation_String__table_nzd_1jr_qr}

## RESTAPIResponse : setStatus(numéro d'état) {#ariaid-title9}

Définit le numéro de code d'état de la réponse de service web.
{#r_SSRB-setStatus_Number__table_tj5_khr_qr__entry__3}

| Nom | Type | Description |
|-|-|-|
| statut | Numéro | Code d'état à envoyer dans la réponse, par exemple 200 pour indiquer la réussite. Le passage d'une valeur non numérique, telle qu'une chaîne, entraîne la valeur par défaut du code d'état sur 0. |
[Tableau 15. Paramètres]

{#r_SSRB-setStatus_Number__table_tj5_khr_qr} {#r_SSRB-setStatus_Number__table_uj5_khr_qr__entry__2}

| Type | Description |
|-|-|
| nul |   |
[Tableau 16. Renvoie]

{#r_SSRB-setStatus_Number__table_uj5_khr_qr}  

    response.setStatus(200);