RESTResponseV2: Bereichsbezogen, global

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 5 Minuten Lesedauer

    • Die RESTResponseV2 Die API bietet Methoden, mit denen Sie die von einer ausgehenden REST-Nachricht zurückgegebenen Daten im JavaScript-Code verwenden können.

    Ein RESTResponseV2-Objekt wird von zurückgegeben RESTMessageV2 Methoden Ausführen () Und ExecuteAsync() .

    Sie können diese API in bereichsbezogenen Anwendungen oder innerhalb des globalen Bereichs verwenden.

    Diese API wird in ausgeführt sn_WS Namespace.

    RESTResponseV2 – getAllHeaders()

    Gibt alle in der Antwort enthaltenen Header zurück, einschließlich aller doppelten Header.

    Tabelle : 1. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 2. Rückgaben
    Typ Beschreibung
    List<GlideHTTPHeader> Liste der Header, die in der Antwort enthalten sind. Jeder Header wird als GlideHTTPHeader-Objekt dargestellt, das den Header enthält Name Und Wert .

    Das folgende Codebeispiel zeigt, wie die REST-Tabellen-API aufgerufen wird, und listet dann alle in der Antwort gefundenen Header auf.

    var request = new sn_ws.RESTMessageV2();
request.setEndpoint('http://<SN_Instance_host>/api/now/table/incident');
request.setHttpMethod('GET');

request.setBasicAuth('username', 'password');
request.setRequestHeader("Accept", "application/json");
var res = request.execute();
if (res.getStatusCode() != 200) {
  gs.info('Bad Request');
}

var headers = res.getAllHeaders();
for(var i in headers){
  gs.info(headers[i].name + ': ' + headers[i].value);
}

    Antwort-Header

    X-Is-Logged-In: true
X-Transaction-ID: e3003cb2db8c
X-Total-Count: 66
X-Content-Type-Options: nosniff
Pragma: no-store,no-cache
Cache-Control: no-cache,no-store,must-revalidate,max-age=-1
Expires: 0
Content-Type: application/json;charset=UTF-8
Date: Fri, 14 May 2021 16:05:10 GMT
Connection: close
Server: ServiceNow
JSESSIONID=5041870726ADADFAB2EE2BF8E7E01596; Path=/; HttpOnly; SameSite=None; Secure
Set-Cookie: glide_user=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly; SameSite=None; Secure
Set-Cookie: glide_user_session=; Max-Age=0; Expires=Thu, 01-Jan-1970 00:00:10 GMT; Path=/; HttpOnly; SameSite=None; Secure
Set-Cookie: glide_user_route=glide.f1aa2015b3fa5fa8dfe567386cde8fd5; Max-Age=2147483647; Expires=Wed, 01-Jun-2089 19:19:17 GMT; Path=/; HttpOnly; SameSite=None; Secure
Set-Cookie: glide_session_store=AF003CB2DB8CF8103DD9C39D139619C7; Max-Age=1800; Expires=Fri, 14-May-2021 16:35:10 GMT; Path=/; HttpOnly; SameSite=None; Secure
Set-Cookie: BIGipServerpool_ddershem=2643023626.45630.0000; path=/; Httponly; Secure; SameSite=None; Secure
Strict-Transport-Security: max-age=63072000; includeSubDomains

    RESTResponseV2 – getBody()

    Ruft den Inhalt des REST-Antworttexts ab.

    Verwenden Sie diese Funktion, wenn Sie den Anforderungstext als Textinhalt abrufen möchten. Verwenden Sie diese Methode nicht, wenn Sie die Antwort als Binäranhang speichern. Wenn ein RESTMessageV2-Objekt genannt wird SaveResponseBodyAsAttachment(...) Funktion, mit GetBody() Verursacht im zugeordneten RESTResponseV2-Objekt einen Fehler. Rufen Sie beim Speichern der Antwort als Anhang an, wenn die ausgehende REST-Nachricht fehlschlägt GetErrorMessage() Auf der Antwort zum Abrufen des Textinhalts.

    Tabelle : 3. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 4. Rückgaben
    Typ Beschreibung
    Zeichenfolge REST-Antworttext. 
    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.execute();
var responseBody = response.getBody();

    RESTResponseV2 – getCookies()

    Gibt alle in der Antwort enthaltenen Cookies zurück.

    Tabelle : 5. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 6. Rückgaben
    Typ Beschreibung
    Objekt Array von Zeichenfolgen, die Cookies darstellen. Iterieren Sie durch das Array, um Vorgänge für jedes Cookie auszuführen.

    Zeigen Sie einzelne Cookies aus der Antwort an.

    var cookies = response.getCookies();
for (var i = 0; i < cookies.length; i++) {
  gs.info('cookie: ' + cookies.get(i));
}
    Ausgabe: 
    cookie: JSESSIONID=4135AA97A5D12DA22EF614AA2B0CAFD8.node20; Path=/; Secure; HttpOnly
cookie: SABASESSIONID=370152970.36895.0000; path=/

    RESTResponseV2 – getErrorCode()

    Ruft den numerischen Fehlercode ab, wenn während der REST-Transaktion ein Fehler aufgetreten ist.

    Dieser Fehlercode ist spezifisch für Now Platform, Ist kein HTTP-Fehlercode. Geben Sie diesen Fehlercode an, wenn Sie Hilfe vom ServiceNow-Kundensupport benötigen.

    Hinweis:
    Um den Inhalt der tatsächlichen Fehlermeldung abzurufen, verwenden Sie GetBody() Methode.
    Tabelle : 7. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 8. Rückgaben
    Typ Beschreibung
    Nummer Numerischer Fehlercode, z. B. 1 für Socket-Zeitüberschreitung. 
    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.execute();
var errorCode = response.getErrorCode();

    RESTResponseV2 – getErrorMessage()

    Ruft die Fehlermeldung ab, wenn während der REST-Transaktion ein Fehler aufgetreten ist.

    Tabelle : 9. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 10. Rückgaben
    Typ Beschreibung
    Zeichenfolge Fehlermeldung. 
    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.execute();
var errorMsg = response.getErrorMessage();

    RESTResponseV2 – getHeader (Zeichenfolgenname)

    Ruft den Wert für einen angegebenen Header ab.

    Tabelle : 11. Parameter
    Name Typ Beschreibung
    name Zeichenfolge Name des Headers, für den Sie den Wert verwenden möchten, z. B. Set-Cookie.
    Tabelle : 12. Rückgaben
    Typ Beschreibung
    Zeichenfolge Wert des angegebenen Headers. 
    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.execute();
var headerVal = response.getHeader("Content-Type");

    RESTResponseV2 – getHeaders()

    Ruft alle in der REST-Antwort zurückgegebenen Header und die zugehörigen Werte ab.

    Hinweis:
    Wenn ein Header in der Antwort mehrmals vorhanden ist, z. B. ein Set-Cookie-Header, gibt diese Funktion nur den letzten der doppelten Header zurück. Um alle Header einschließlich Duplikate zurückzugeben, verwenden Sie die GetAllHeader() Funktion.
    Tabelle : 13. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 14. Rückgaben
    Typ Beschreibung
    Objekt Objekt, das den Namen jedes Headers dem zugeordneten Wert zuordnet. 
    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.execute();
var headers = response.getHeaders();

    RESTResponseV2 – getQueryString()

    Ruft die vollständig aufgelöste Abfrage ab, die an den REST-Endpunkt gesendet wird.

    Diese Abfrage enthält die Endpunkt-URL sowie alle Werte, die Variablen in der REST-Nachricht zugewiesen sind. Verwenden Sie diese Methode nur mit Antworten auf direkte Anforderungen. Diese Methode wird für asynchrone oder über einen MID-Server gesendete Anforderungen nicht unterstützt.

    Tabelle : 15. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 16. Rückgaben
    Typ Beschreibung
    Zeichenfolge Vollständig aufgelöste Abfrage. 
    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.execute();
var queryString = response.getQueryString();

    RESTResponseV2 – getResponseAttachmentSysid()

    Ruft den sys_ID-Wert des Anhangs ab, der aus dem Inhalt des Antworttexts erstellt wurde.

    Wenn das mit dieser Antwort verknüpfte RESTMessageV2-Objekt als bezeichnet wird SaveResponseBodyAsAttachment(...) Funktion, verwenden GetResponseAttachmentSysid() Zum Abrufen der sys_ID des erstellten Anhangsdatensatzes. Verwenden Sie diese Funktion, wenn Sie zusätzliche Vorgänge mit dem neuen Anhangsdatensatz ausführen möchten.

    Tabelle : 17. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 18. Rückgaben
    Typ Beschreibung
    Zeichenfolge SYS_ID des neuen Anhangdatensatzes.

    RESTResponseV2 – getStatusCode()

    Ruft den numerischen HTTP-Statuscode ab, der vom REST-Provider zurückgegeben wird.

    Tabelle : 19. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 20. Rückgaben
    Typ Beschreibung
    Nummer Numerischer Statuscode, der vom REST-Provider zurückgegeben wird, z. B. 200 für eine erfolgreiche Antwort. 
    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.execute();
var statusCode = response.getStatusCode();

    RESTResponseV2 – haveError()

    Gibt an, ob während der REST-Transaktion ein Fehler aufgetreten ist.

    Tabelle : 21. Parameter
    Name Typ Beschreibung
    Keine
    Tabelle : 22. Rückgaben
    Typ Beschreibung
    boolean Gibt „wahr“ zurück, wenn ein Fehler aufgetreten ist, „falsch“, wenn kein Fehler aufgetreten ist. 
    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.execute();
var error = response.haveError();

    RESTResponseV2 – waitForResponse(Number timeoutSecs)

    Legen Sie fest, wie lange die Instanz auf eine Antwort des Webservice Providers wartet.

    Diese Methode überschreibt die Eigenschaft „Glide.Rest.outbound.ecc_response.timeout“ für diese REST-Antwort.

    Tabelle : 23. Parameter
    Name Typ Beschreibung
    ZeitüberschreitungsSekunden Nummer Die Wartezeit in Sekunden für diese Antwort.
    Tabelle : 24. Rückgaben
    Typ Beschreibung
    Ungültig 
    var sm = new sn_ws.RESTMessageV2("Yahoo Finance","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.executeAsync();
response.waitForResponse(60);