RESTAPIResponseStream – Bereichsbezogen, Global

Die RESTAPIResponseStream -API stellt Methoden bereit, mit denen Sie direkt in den geskripteten REST-API-Antwortstream schreiben können.

Verwenden Sie die RESTAPIResponseStream -Methoden, um Webservice-APIs in der Funktion „Geskriptete REST-API“ zu 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.

RESTAPIResponseStream – writeStream(Object stream)

Schreibt einen Eingabe-Stream in den Antwort-Stream.

Sie müssen den Content-Typ und den Statuscode vor dem Aufrufen der Methode writeStream() festlegen, oder die Antwort schlägt fehl. Sie können diese Werte nach dem Aufrufen der Methode writeStream() nicht ändern.

Hinweis:

Es liegt in der Verantwortung des Skriptautors, den Stream von einem Service eines Drittanbieters zu beziehen.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
stream	Objekt	Ein Anhang oder ein Antwort-Stream von einem Drittanbieterservice.

Tabelle : 2. Ergebnisse

Typ	Beschreibung
void

Das folgende Beispiel gilt für bereichsbezogene Anwendungen:

(function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {

    response.setContentType('application/json');
    response.setStatus(200);

    var gsa = new GlideSysAttachment();
    var attachmentStream = new gsa.getContentStream(<sys_id of attachment>); 
    var writer = response.getStreamWriter();
    writer.writeStream(attachmentStream);

})(request, response);

Das folgende Beispiel gilt für globale Anwendungen:

(function process(/*RESTAPIRequest*/ request, /*RESTAPIResponse*/ response) {

    response.setContentType('application/json');
    response.setStatus(200);

    var attachmentStream = new GlideSysAttachmentInputStream(<sys_id of attachment>);
    var writer = response.getStreamWriter();
    writer.writeStream(attachmentStream);

})(request, response);

RESTAPIResponseStream – writeString(String data)

Schreibt Zeichenfolgendaten in den Antwort-Stream.

Sie müssen den Content-Typ und den Statuscode vor dem Aufrufen der Methode writeString() festlegen, oder die Antwort schlägt fehl. Sie können diese Werte nach dem Aufrufen der Methode writeString() nicht ändern.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
data	Zeichenfolge	Die Zeichenfolge, die den Antwortdaten hinzugefügt werden soll.

Tabelle : 4. Ergebnisse

Typ	Beschreibung
void

response.setContentType('application/json');
response.setStatus(200);
var writer = response.getStreamWriter();
var body ={
  name:user1,
  id: 1234,
  roles: [
    {
      name: admin
    },
    {
      name: itil
    }
  ]
}
writer.writeString("{'name':'user','id':'1234'}");
writer.writeString(JSON.stringify(body));