RESTAPIResponse – Bereichsbezogen, Global

Mit der RESTAPIResponse- API können Sie eine RESTful-Antwort auf eine geskriptete REST-API-Anforderung erstellen.

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

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.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 2. Ergebnisse

Typ	Beschreibung
RESTAPIResponseStream – Bereichsbezogen, Global	Der ResponseStreamWriter für diese Antwort. Mit diesem Objekt können Sie direkt in den Antwortstream schreiben.

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

RESTAPIResponse – setBody(Object body)

Legt den Textkörperinhalt fest, der in der Webservice-Antwort gesendet werden soll.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
body	Objekt	Der Antwort-Haupttext als JavaScript-Objekt. Der Textinhalt wird abhängig vom Wert der in der Anforderung übergebenen Accept -Kopfzeile automatisch in JSON oder XML serialisiert.

Tabelle : 4. Ergebnisse

Typ	Beschreibung
void

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)

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.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
contentType	Zeichenfolge	Der Content-Typ des Antwort-Haupttexts, z. B. „application/json“.

Tabelle : 6. Ergebnisse

Typ	Beschreibung
void

response.setContentType('application/json');

RESTAPIResponse - setError(Object error)

Konfiguriert die REST-Antwort so, dass ein Fehler zurückgegeben wird.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
error	Objekt	Fehlerobjekt. Weitere Informationen zu den Typen von Fehlerobjekten, die verwendet werden können, finden Sie unter Beispiel für Scripted REST APIs – Skriptbeispiele.

Tabelle : 8. Ergebnisse

Typ	Beschreibung
void

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(String header, String value)

Weist einer REST-Service-Antwortkopfzeile einen Wert zu.

Tabelle : 9. Parameter

Name	Typ	Beschreibung
header	Zeichenfolge	Die Kopfzeile, die Sie festlegen möchten.
Wert	Zeichenfolge	Der Wert, der der angegebenen Kopfzeile zugewiesen werden soll.

Tabelle : 10. Ergebnisse

Typ	Beschreibung
void

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

RESTAPIResponse – setHeaders(Object headers)

Legt die Kopfzeilen für die Webservice-Antwort fest.

Tabelle : 11. Parameter

Name	Typ	Beschreibung
headers	Objekt	Ein JavaScript-Objekt, das jede Kopfzeile und den Wert zum Zuordnen der Kopfzeile auflistet.

Tabelle : 12. Ergebnisse

Typ	Beschreibung
void

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

RESTAPIResponse – setLocation(String location)

Weist der Location-Kopfzeile in der Webservice-Antwort einen Wert zu.

Weitere Informationen zu dieser Kopfzeile finden Sie in der W3 LocationHeader-Dokumentation.

Tabelle : 13. Parameter

Name	Typ	Beschreibung
Keine	Zeichenfolge	Ein absoluter URI, an den der Antwortempfänger umgeleitet werden soll.

Tabelle : 14. Ergebnisse

Typ	Beschreibung
void

RESTAPIResponse – setStatus(Number status)

Legt die Statuscodenummer für die Webservice-Antwort fest.

Tabelle : 15. Parameter

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 : 16. Ergebnisse

Typ	Beschreibung
void

response.setStatus(200);