---
sourceDocument: Yokohama-API-Referenz
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/api-reference

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# RESTAPIResponse: Bereichsbezogen, global

# RESTAPIResponse: Bereichsbezogen, global {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

Die RESTAPIAntwort Die API bietet Methoden, mit denen Sie eine RESTful Antwort auf eine geskriptete REST-API-Anforderung erstellen können.

Diese API wird in ausgeführt `sn_WS `Namespace.  
Hinweis:  
Sie können keine Objekte dieses Typs instanziieren. Objekte dieses Typs werden automatisch erstellt und sind nur in geskripteten REST-API-Ressourcenskripts zugänglich.

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

Gibt den ResponseStreamWriter für diese Antwort zurück, sodass Sie direkt in den Antwortstrom schreiben können.
Legen Sie den Inhaltstyp und den Statuscode mit fest SetHeader Und SetStatus Funktioniert vor dem Aufrufen von GetStreamWriter Funktion.
{#r_SSRB-getStreamWriter__table_wnn_glb_sr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine |   |   |
[Tabelle : 1. Parameter]

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

| Typ | Beschreibung |
|-|-|
| RESTAPIResponseStream: Bereichsbezogen, global | Der ResponseStreamWriter für diese Antwort. Sie können dieses Objekt verwenden, um direkt in den Antwortstrom zu schreiben. |
[Tabelle : 2. Rückgaben]

{#r_SSRB-getStreamWriter__table_xnn_glb_sr}  

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

## RESTAPIResponse -- setBody(Objekttext) {#ariaid-title3}

Legt den Textkörper fest, der in der Webserviceantwort gesendet werden soll.
{#r_SSRB-setBody_Object__table_yzt_cmr_qr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| body | Objekt | Der Antworttext als JavaScript-Objekt. Der Textinhalt wird je nach Wert von automatisch in JSON oder XML serialisiert AcceptHeader in der Anforderung übergeben. |
[Tabelle : 3. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 4. Rückgaben]

{#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(Zeichenfolge contentType) {#ariaid-title4}

Weist dem Inhaltstyp-Header in der Webserviceantwort einen Wert zu.
Sie müssen einen Antwortinhaltstyp festlegen, bevor Sie die Antwort schreiben. Der Inhaltstyp wird automatisch für Zeichenfolgenantworten festgelegt, basierend auf dem Headerwert für die Anforderungsakzeptanz.

Durch das Festlegen eines ungültigen Inhaltstyps wird die Antwort standardmäßig auf JSON festgelegt. Wenn Sie einen Inhaltstyp nicht festlegen, wird beim Senden einer binären Antwort ein Statuscode 500-Fehler angezeigt.

Siehe [Headerdokumentation für W3-Inhaltstyp](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17)Um weitere Informationen zu diesem Header zu erhalten.
{#r_SSRB-setContentType_String__table_dcn_3lr_qr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Inhaltstyp | Zeichenfolge | Der Inhaltstyp des Antworttexts, z. B. „Application/JSON". |
[Tabelle : 5. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 6. Rückgaben]

{#r_SSRB-setContentType_String__table_ecn_3lr_qr}  

    response.setContentType('application/json');

## RESTAPIResponse -- setError(Objektfehler) {#ariaid-title5}

Konfiguriert die REST-Antwort so, dass ein Fehler zurückgegeben wird.
{#r_SSRB-setError_O__table_apv_hb3_zs__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Fehler | Objekt | Fehlerobjekt. Weitere Informationen zu den Typen von Fehlerobjekten, die verwendet werden können, finden Sie unter [Beispiel für geskriptete REST-API: Skriptbeispiele](https://servicenow-prod.fluidtopics.net/ceJCdY81l2BAdkYVZCnwrA "Diese Beispiele demonstrieren, wie verschiedene Ressourcenskripts für eine geskriptete REST-API erstellt werden."). |
[Tabelle : 7. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 8. Rückgaben]

{#r_SSRB-setError_O__table_bpv_hb3_zs}  
Das folgende Beispiel zeigt, wie ein Fehler aus einer geskripteten REST-Ressource zurückgegeben wird.

    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 (Zeichenfolgenheader, Zeichenfolgenwert) {#ariaid-title6}

Weisen Sie einem REST-Service-Antwortheader einen Wert zu.
{#r_SSRB-setHeader_String_String__table_und_rt4_gs__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| header | Zeichenfolge | Der Header, den Sie festlegen möchten. |
| Wert | Zeichenfolge | Der Wert, der dem angegebenen Header zugewiesen werden soll. |
[Tabelle : 9. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 10. Rückgaben]

{#r_SSRB-setHeader_String_String__table_vnd_rt4_gs}  

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

## RESTAPIResponse -- setHeader (Objekt-Header) {#ariaid-title7}

Legt die Header für die Webserviceantwort fest.
{#r_SSRB-setHeaders_Object__table_slb_j3r_qr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| headers | Objekt | Ein JavaScript-Objekt, das jeden Header und den Wert zum Zuweisen dieses Headers auflistet. |
[Tabelle : 11. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 12. Rückgaben]

{#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(Zeichenfolgenposition) {#ariaid-title8}

Weist dem Standort-Header in der Webservice-Antwort einen Wert zu.
Siehe [Dokumentation zum W3-Standort-Header](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30)Um weitere Informationen zu diesem Header zu erhalten.
{#r_SSRB-setLocation_String__table_mzd_1jr_qr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Keine | Zeichenfolge | Ein absoluter URI, an den der Antwortempfänger umgeleitet werden soll. |
[Tabelle : 13. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 14. Rückgaben]

{#r_SSRB-setLocation_String__table_nzd_1jr_qr}

## RESTAPIResponse -- setStatus (Zahlenstatus) {#ariaid-title9}

Legt die Statuscodenummer für die Webserviceantwort fest.
{#r_SSRB-setStatus_Number__table_tj5_khr_qr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| Status | Nummer | Der Statuscode, der in der Antwort gesendet werden soll, z. B. 200, um den Erfolg anzugeben. Durch die Übergabe eines nicht numerischen Werts, z. B. einer Zeichenfolge, wird der Statuscode standardmäßig auf 0 gesetzt. |
[Tabelle : 15. Parameter]

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

| Typ | Beschreibung |
|-|-|
| Ungültig |   |
[Tabelle : 16. Rückgaben]

{#r_SSRB-setStatus_Number__table_uj5_khr_qr}  

    response.setStatus(200);


