---
sourceDocument: Xanadu-API-Referenz
sourceDocumentLink: https://www.servicenow.com/docs/r/de-DE/xanadu/api-reference

 Release :

    - xanadu

ft:locale :

    - de-DE

ft:publication_title :

    - Xanadu-API-Referenz

ft:clusterId :

    - crapiref

bundleId :

    - crapiref

workflow :

    - Creator


---

# RESTAPIResponse -- Bereichsbezogen, Global

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

* Freigeben Version: Xanadu
* 
* Aktualisiert 1. August 2024
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

Die RESTAPIResponse- API stellt Methoden bereit, mit denen Sie eine RESTful-Antwort auf eine geskriptete REST-API-Anforderung erstellen 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.

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

Gibt den ResponseStreamWriter für diese Antwort zurück, sodass Sie direkt in den Antwortstream schreiben können.
Legen Sie den Content-Typ und den Statuscode mit den Funktionen setHeaders und setStatus fest, bevor Sie die Funktion getStreamWriter aufrufen.
{#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. Mit diesem Objekt können Sie direkt in den Antwortstream schreiben. |
[Tabelle : 2. Ergebnisse]

{#r_SSRB-getStreamWriter__table_xnn_glb_sr}  

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

## RESTAPIResponse -- setBody(Object body) {#ariaid-title3}

Legt den Textkörperinhalt fest, der in der Webservice-Antwort gesendet werden soll.
{#r_SSRB-setBody_Object__table_yzt_cmr_qr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| body | Objekt | Der Antwort-Haupttext als JavaScript-Objekt. Der Textinhalt wird abhängig vom Wert des in der Anforderung übergebenen Headers Accept automatisch in JSON oder XML serialisiert. |
[Tabelle : 3. Parameter]

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

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 4. Ergebnisse]

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

Weist der Content-Type-Kopfzeile in der Webservice-Antwort einen Wert zu.
Sie müssen einen Antwort-Content-Typ festlegen, bevor Sie die Antwort schreiben. Der Content-Typ wird automatisch für Zeichenfolgenantworten festgelegt, basierend auf der Anforderungskopfzeile-Wert von „Accept".

Das Festlegen eines ungültigen Content-Typs bewirkt, dass die Antwort standardmäßig JSON verwendet. Wenn Sie keinen Content-Typ festlegen, wird beim Senden einer binären Antwort ein Fehler mit dem Statuscode 500 angezeigt.

Weitere Informationen zu dieser Kopfzeile finden Sie in der [W3 Content-Type-Kopfzeilen-Dokumentation](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.17).
{#r_SSRB-setContentType_String__table_dcn_3lr_qr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| contentType | Zeichenfolge | Der Content-Typ des Antwort-Haupttexts, 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 |
|-|-|
| void |   |
[Tabelle : 6. Ergebnisse]

{#r_SSRB-setContentType_String__table_ecn_3lr_qr}  

    response.setContentType('application/json');

## RESTAPIResponse - setError(Object error) {#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 |
|-|-|-|
| error | Objekt | Fehlerobjekt. Weitere Informationen zu den verwendbaren Fehlerobjekttypen finden Sie unter [Beispiel für Scripted REST APIs -- Skriptbeispiele](https://www.servicenow.com/docs/XlMXjgx2piwiw_BSAAHu3Q "Diese Beispiele zeigen, wie verschiedene Ressourcen-Skripts 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 |
|-|-|
| void |   |
[Tabelle : 8. Ergebnisse]

{#r_SSRB-setError_O__table_bpv_hb3_zs}  
Das folgende Beispiel zeigt, wie aus einer geskripteten REST-Ressource ein Fehler 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(String header, String value) {#ariaid-title6}

Weist einer REST-Service-Antwortkopfzeile einen Wert zu.
{#r_SSRB-setHeader_String_String__table_und_rt4_gs__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| header | Zeichenfolge | Die Kopfzeile, die Sie festlegen möchten. |
| Wert | Zeichenfolge | Der Wert, der der angegebenen Kopfzeile 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 |
|-|-|
| void |   |
[Tabelle : 10. Ergebnisse]

{#r_SSRB-setHeader_String_String__table_vnd_rt4_gs}  

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

## RESTAPIResponse -- setHeaders(Object headers) {#ariaid-title7}

Legt die Kopfzeilen für die Webservice-Antwort fest.
{#r_SSRB-setHeaders_Object__table_slb_j3r_qr__entry__3}

| Name | Typ | Beschreibung |
|-|-|-|
| headers | Objekt | Ein JavaScript-Objekt, das jede Kopfzeile und den Wert zum Zuordnen der Kopfzeile auflistet. |
[Tabelle : 11. Parameter]

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

| Typ | Beschreibung |
|-|-|
| void |   |
[Tabelle : 12. Ergebnisse]

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

Weist der Location-Kopfzeile in der Webservice-Antwort einen Wert zu.
Weitere Informationen zu dieser Kopfzeile finden Sie in der [W3 LocationHeader-Dokumentation](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html#sec14.30).
{#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 |
|-|-|
| void |   |
[Tabelle : 14. Ergebnisse]

{#r_SSRB-setLocation_String__table_nzd_1jr_qr}

## RESTAPIResponse -- setStatus(Number status) {#ariaid-title9}

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

| Name | Typ | Beschreibung |
|-|-|-|
| Status | Zahl | Der Statuscode zum Senden der Antwort, z. B. 200, um den Erfolg anzuzeigen. Wenn Sie einen nicht numerischen Wert übergeben, z. B. eine 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 |
|-|-|
| void |   |
[Tabelle : 16. Ergebnisse]

{#r_SSRB-setStatus_Number__table_uj5_khr_qr}  

    response.setStatus(200);