RESTMessageV2 – Bereichsbezogen, Global

Die RESTMessageV2- API bietet Methoden, mit denen Sie ausgehende REST-Nachrichten mit JavaScript senden können.

Verwenden Sie diese API, um die vom REST-Anbieter zurückgegebene Antwort zu verwalten.

Der Wert für „User-Agent“ lautet „ServiceNow/1.0“. Um dies zu ändern, fügen Sie die Systemeigenschaft glide.http.user.agent in der Tabelle „Systemeigenschaften“ [sys_properties] hinzu.

Diese API wird im Namespace sn_ws ausgeführt.

RESTMessageV2 – RESTMessageV2()

Instantiiert ein leeres RESTMessageV2-Objekt.

Wenn Sie ein Objekt verwenden, das auf diese Weise instantiiert wurde, müssen Sie manuell eine HTTP-Methode und einen Endpunkt angeben.

Tabelle : 1. Parameter

Name	Typ	Beschreibung
Keine

var sm = new sn_ws.RESTMessageV2();

RESTMessageV2 – RESTMessageV2(String name, String methodName)

Instantiiert ein RESTMessageV2-Objekt unter Verwendung von Informationen aus einem REST-Nachrichtendatensatz.

Sie müssen einen REST-Nachrichtendatensatz definieren, bevor Sie diesen Konstruktor verwenden können.

Tabelle : 2. Parameter

Name	Typ	Beschreibung
Name	Zeichenfolge	Der Name des REST-Nachrichtendatensatzes.
methodName	Zeichenfolge	Der Name der zu verwendenden HTTP-Methode, z. B. GET/get oder PUT/put (Groß-/Kleinschreibung beachten).

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.

RESTMessageV2 – disableForcedVariableSubstitution()

Deaktiviert erzwungene Variablensubstitution bei ausgehenden REST-Nachrichten.

Hinweis:

Die Verwendung von geschweiften Klammern oder Dollar-Zeichen in Ihrer Anforderung kann versehentlich zu einer gekürzten Ausgabe führen. Wenn Ihre Anforderung die Antwort irrtümlich kürzt oder in neue Zeilen aufteilt, finden Sie in diesem Community-Artikel eine mögliche Lösung.

Tabelle : 3. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 4. Ergebnisse

Typ	Beschreibung
void

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get");
sm.disableForcedVariableSubstitution();
var response = sm.execute();

RESTMessageV2 – execute()

Sendet die REST-Nachricht an den Endpunkt.

Tabelle : 5. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 6. Ergebnisse

Typ	Beschreibung
RESTResponse	Die vom REST-Provider zurückgegebene Antwort.

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.execute(); //Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.

RESTMessageV2: executeAsync()

Sendet die REST-Nachricht asynchron an den Endpunkt. Die Instanz wartet nicht auf eine Antwort des Webservice-Providers, wenn asynchrone Aufrufe ausgeführt werden.

Tabelle : 7. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 8. Ergebnisse

Typ	Beschreibung
RESTResponse	Die vom REST-Provider zurückgegebene Antwort.

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz. Erwägen Sie bei der Verwendung von executeAsync die Verarbeitung des Antworttexts in einer separaten Business Rule, um den asynchronen Aufruf zu nutzen.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var response = sm.executeAsync(); //Might throw exception if http connection timed out or some issue with sending request itself because of encryption/decryption of password.

RESTMessageV2 – getEndpoint()

Ruft die URL des Endpunkts für die REST-Nachricht ab.

Tabelle : 9. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 10. Ergebnisse

Typ	Beschreibung
Zeichenfolge	Die URL des REST-Webservice-Providers.

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var endpoint = sm.getEndpoint();

RESTMessageV2 – getRequestBody()

Ruft den Inhalt des REST-Nachrichtentexts ab.

Tabelle : 11. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 12. Ergebnisse

Typ	Beschreibung
Zeichenfolge	Der REST-Nachrichtentext.

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var body = sm.getRequestBody();

RESTMessageV2 – getRequestHeader(String headerName)

Ruft den Wert für einen in der REST-Nachricht angegebenen HTTP-Header ab.

Standardmäßig kann diese Methode den Wert für eine vom System automatisch festgelegte Kopfzeile nicht zurückgeben. Um dieser Methode Zugriff auf alle Kopfzeilen zu gewähren, setzen Sie die Eigenschaft „glide.http.log_debug“ auf „true“.

Tabelle : 13. Parameter

Name	Typ	Beschreibung
headerName	Zeichenfolge	Anforderungsheader, für den Sie den Wert abrufen möchten.

Tabelle : 14. Ergebnisse

Typ	Beschreibung
Zeichenfolge	Der Wert der angegebenen Kopfzeile.

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var header = sm.getRequestHeader("Accept");

RESTMessageV2 – getRequestHeaders()

Ruft HTTP-Header ab, die vom REST-Client festgelegt wurden, und die zugehörigen Werte.

Diese Methode gibt keine vom System automatisch festgelegten Kopfzeilen zurück. Um diese Methode so zu konfigurieren, dass alle Kopfzeilen zurückgegeben werden, setzen Sie die Eigenschaft „glide.http.log_debug“ auf „true“.

Tabelle : 15. Parameter

Name	Typ	Beschreibung
Keine

Tabelle : 16. Ergebnisse

Typ	Beschreibung
Objekt	Ein Objekt, das den Namen jeder Kopfzeile dem zugehörigen Wert zuordnet.

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
var headers = sm.getRequestHeaders();

RESTMessageV2 – saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName)

Konfiguriert die REST-Nachricht, um den zurückgegebenen Antwort-Haupttext als Anhangsdatensatz zu speichern.

Wenn Sie diese Funktion mit einer REST-Nachricht verwenden, die über einen MID-Server gesendet wird, muss der MID-Server-Benutzer über alle Rollen verfügen, die zum Lesen und Schreiben von Anhangsdatensätzen erforderlich sind, sowie über alle Rollen, die zum Lesen und Schreiben von Datensätzen in der in angegebenen Tabelle erforderlich sind tableName Parameter.

Der Antwort-Haupttext muss keine binäre Datei sein, um als Anhang gespeichert zu werden. Antwort-Haupttextkörper, die Textformate wie JSON oder XML verwenden, können ebenfalls gespeichert werden. Wenn die Instanz den Anhang nicht speichern kann, rufen Sie getErrorMessage() für das zugehörige RESTResponseV2-Objekt auf, um Fehlerdetails zu erhalten.

Tabelle : 17. Parameter

Name	Typ	Beschreibung
tableName	Zeichenfolge	Geben Sie die Tabelle an, die den Datensatz enthält, an den Sie die gespeicherte Datei anhängen möchten.
recordSysId	Zeichenfolge	Geben Sie die sys_id des Datensatzes an, an den Sie die gespeicherte Datei anhängen möchten.
fileName	Zeichenfolge	Geben Sie den Dateinamen für die gespeicherte Datei an.

Tabelle : 18. Ergebnisse

Typ	Beschreibung
void

(function sampleRESTMessageV2() {
  try{
    var request  = new sn_ws.RESTMessageV2();        
    request.setHttpMethod('get');

    var attachment_sys_id  = '<attachment_record_sys_id>', 
      tablename = 'incident',
      recordSysId = '<incident_sys_id>',            
      response,            
      httpResponseStatus,             
      filename ='<filename>';

    //endpoint - ServiceNow REST Attachment API        
    request.setEndpoint('https://<instance_name>.service-now.com/api/now/attachment/' + attachment_sys_id  +'/file');        
    request.setBasicAuth('<username>', '<password>');

    //RESTMessageV2 - saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName)        
    request.saveResponseBodyAsAttachment(tablename, recordSysId, filename);        

    response = request.execute();        
    httpResponseStatus = response.getStatusCode();  
      
    gs.info(" http response status_code:  " + httpResponseStatus);    
  }
  catch(ex){
    var message  = ex.getMessage();        
    gs.info(message);    
  }
})();

RESTMessageV2 – saveResponseBodyAsAttachment(String tableName, String recordSysId, String fileName, String encryptContext)

Konfiguriert die REST-Nachricht so, dass der zurückgegebene Antworttext als verschlüsselter Anhangsdatensatz gespeichert wird.

Wenn Sie diese Funktion mit einer REST-Nachricht verwenden, die über einen MID-Server gesendet wird, muss der MID-Server-Benutzer über alle Rollen verfügen, die zum Lesen und Schreiben von Anhangsdatensätzen erforderlich sind, sowie über alle Rollen, die zum Lesen und Schreiben von Datensätzen in der in angegebenen Tabelle erforderlich sind tableName Parameter.

Der Antwort-Haupttext muss keine binäre Datei sein, um als Anhang gespeichert zu werden. Antwort-Haupttextkörper, die Textformate wie JSON oder XML verwenden, können ebenfalls gespeichert werden. Wenn die Instanz den Anhang nicht speichern kann, rufen Sie getErrorMessage() für das zugehörige RESTResponseV2-Objekt auf, um Fehlerdetails zu erhalten.

Tabelle : 19. Parameter

Name	Typ	Beschreibung
tableName	Zeichenfolge	Geben Sie die Tabelle an, die den Datensatz enthält, an den Sie die gespeicherte Datei anhängen möchten.
recordSysId	Zeichenfolge	Geben Sie die sys_id des Datensatzes an, an den Sie die gespeicherte Datei anhängen möchten.
fileName	Zeichenfolge	Geben Sie den Dateinamen für die gespeicherte Datei an.
encryptContext	Zeichenfolge	Geben Sie die sys_id eines Verschlüsselungskontextes an. Die gespeicherte Datei wird mit diesem Kontext verschlüsselt.

Tabelle : 20. Ergebnisse

Typ	Beschreibung
void

RESTMessageV2 – setAuthenticationProfile(String type, String profileId)

Legt die Anmeldeinformationen für die REST-Nachricht mit einem vorhandenen Standardauthentifizierungs- oder OAuth 2.0-Profil fest.

Tabelle : 21. Parameter

Name	Typ	Beschreibung
Typ	Zeichenfolge	Der Typ des zu verwendenden Authentifizierungsprofils. Gültige Werte sind „basic“ zur Verwendung der Basic Authentication oder „oauth2“ zur Verwendung von OAuth 2.0.
profileId	Zeichenfolge	Die sys_id eines Authentifizierungsprofileintrags. Geben Sie bei Verwendung der Basic Authentication die sys_id eines Datensatzes der Konfiguration für Basic Authentication [sys_auth_profile_basic] an. Geben Sie bei Verwendung von OAuth 2.0 die sys_id eines Datensatzes des OAuth-Einheitenprofils [oauth_entity_profile] an.

Tabelle : 22. Ergebnisse

Typ	Beschreibung
void

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var requestBody;
var responseBody;
var status;
var sm;
try{
       // Might throw exception if message doesn't exist or not visible due to scope.
	sm = new sn_ws.RESTMessageV2("<REST_message_record>", "get");  

       //set auth profile to an OAuth 2.0 profile record.
	sm.setAuthenticationProfile('oauth2', '1234adsf123212131123qasdsf'); 

	sm.setStringParameter("symbol", "NOW");
	sm.setStringParameterNoEscape("xml_data","<data>test</data>");

       //In milliseconds. Wait at most 10 seconds for response from http request.
	sm.setHttpTimeout(10000); 
       //Might throw exception if http connection timed out or some issue 
       //with sending request itself because of encryption/decryption of password.
	response = sm.execute();	
       responseBody = response.haveError() ? response.getErrorMessage() : response.getBody();
	status = response.getStatusCode();
} catch(ex) {
	responseBody = ex.getMessage();
	status = '500';
} finally {
	requestBody = sm ? sm.getRequestBody():null;
}

RESTMessageV2 – setBasicAuth(String userName, String userPass)

Legt die Basic Authentication-Kopfzeilen für die REST-Nachricht fest.

Das Festlegen von Sicherheitswerten mit dieser Methode überschreibt die Basic Authenticationwerte, die für den REST-Nachrichtendatensatz definiert sind.

Tabelle : 23. Parameter

Name	Typ	Beschreibung
userName	Zeichenfolge	Anwendername, den Sie zum Authentifizieren der REST-Nachricht verwenden möchten.
userPass	Zeichenfolge	Passwort für den angegebenen Anwender.

Tabelle : 24. Ergebnisse

Typ	Beschreibung
void

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setBasicAuth("username","password");

RESTMessageV2 – setEccCorrelator(String correlator)

Ordnet ausgehende Anforderungen und den daraus resultierenden Antwortdatensatz in der ECC-Warteschlange zu. Diese Methode gilt nur für REST-Nachrichten, die über MID-Servergesendet werden.

Der bereitgestellte Korrelator füllt das Feld Agenten-Korrelator im ECC-Warteschlangendatensatz für die Antwort aus. Stellen Sie für jede ausgehende Anforderung einen eindeutigen Korrelator bereit, um die richtigen Ergebnisse in der ECC-Warteschlange mit der Anforderung zu verknüpfen, wenn Sie asynchrone Automatisierung über einen MID-Server entwerfen.

Tabelle : 25. Parameter

Name	Typ	Beschreibung
Korrelator	Zeichenfolge	Eindeutiger Bezeichner

Tabelle : 26. Ergebnisse

Typ	Beschreibung
void

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setEccCorrelator("unique_identifier");

RESTMessageV2 – setEccParameter(String name, String value)

Überschreibt einen Wert aus der Datenbank, indem in die Nutzlast der REST-Nachricht geschrieben wird. Diese Methode gilt nur für REST-Nachrichten, die über einen MID-Server gesendet werden.

Verwenden Sie diese Methode, wenn ein Wert aus der REST-Nachricht in der Datenbank ungültig ist, z. B. wenn die Endpunkt-URL länger als die maximale REST-Endpunktfeldlänge ist. Sie können nur die Endpunkt-URL mit dieser Methode festlegen, indem Sie „source“ als Namensparameter übergeben.

Tabelle : 27. Parameter

Name	Typ	Beschreibung
Name	Zeichenfolge	Der Name des Parameters, z. B. „source“.
Wert	Zeichenfolge	Der Wert, der dem angegebenen Parameter zugewiesen werden soll.

Tabelle : 28. Ergebnisse

Typ	Beschreibung
void

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setEccParameter("source","http://very.long.endpoint.url");

RESTMessageV2 – setEndpoint(String endpoint)

Legt den Endpunkt für die REST-Nachricht fest.

Standardmäßig verwendet die REST-Nachricht den im REST-Nachrichtendatensatz angegebenen Endpunkt. Verwenden Sie diese Methode, um diesen Standardwert zu überschreiben. Sie müssen diese Methode bei der Verwendung des RESTMessageV2 – RESTMessageV2()-Konstruktors ohne Parameter aufrufen.

Tabelle : 29. Parameter

Name	Typ	Beschreibung
endpoint	Zeichenfolge	Die URL des REST-Providers, mit dem Sie eine Schnittstelle herstellen möchten.

Tabelle : 30. Ergebnisse

Typ	Beschreibung
void

var sm = new sn_ws.RESTMessageV2();
sm.setEndpoint("http://web.service.endpoint");

RESTMessageV2 – setHttpMethod(String method)

Legt die HTTP-Methode fest, die diese REST-Nachricht verwendet, z. B. GET oder PUT.

Sie müssen eine HTTP-Methode festlegen, wenn Sie den RESTMessageV2 – RESTMessageV2()-Konstruktor ohne Parameter verwenden.

Tabelle : 31. Parameter

Name	Typ	Beschreibung
method	Zeichenfolge	Auszuführende HTTP-Methode.

Tabelle : 32. Ergebnisse

Typ	Beschreibung
void

var sm = new sn_ws.RESTMessageV2();
sm.setHttpMethod("post");

RESTMessageV2 – setHttpTimeout(Number timeoutMs)

Legt fest, wie lange die REST-Nachricht auf eine Antwort vom Webservice-Provider wartet, bevor die Anforderung abläuft.

Tabelle : 33. Parameter

Name	Typ	Beschreibung
timeoutMs	Nummer	Zeit in Millisekunden, bis der Aufruf an den REST-Provider abläuft. Hinweis: Dieser Wert legt eine Zeitüberschreitung für den Socket fest. Diese Zeitüberschreitung tritt nur dann ein, wenn der Socket innerhalb der angegebenen Zeit keine Daten empfängt. In Umgebungen, in denen Antworten gestreamt werden, können Verbindungen viel länger dauern als der Zeitüberschreitungswert.

Tabelle : 34. Ergebnisse

Typ	Beschreibung
Keine

Um das folgende Beispiel zu verwenden, ersetzen Sie<REST_message_record> mit dem Namen des REST-Nachrichtendatensatzes aus Ihrer -Instanz.

// Might throw exception if message doesn't exist or not visible due to scope.
var sm = new sn_ws.RESTMessageV2("<REST_message_record>", "get");
sm.setHttpTimeout(6000);

RESTMessageV2 – setLogLevel(String level)

Legt die Protokollebene für diese Nachricht und die entsprechende Antwort fest.

Durch das Festlegen einer Protokollebene mithilfe der RESTMessageV2-API wird die für den REST-Nachrichtendatensatz konfigurierte Protokollebene überschrieben. Diese Protokollebene gilt möglicherweise nicht, wenn die Endpunktdomäne ausgeschlossen ist oder wenn die Eigenschaft glide.outbound_http_log.override auf „wahr“ festgelegt ist. Um Protokolle für ausgehende Webservices anzuzeigen, navigieren Sie zu Systemprotokolle > Ausgehende HTTP-Anforderungen.

Tabelle : 35. Parameter

Name	Typ	Beschreibung
level	Zeichenfolge	Die Protokollebene. Gültige Werte sind „basic“, „elevated“ und „all“.

Tabelle : 36. Ergebnisse

Typ	Beschreibung
void

var rm = new sn_ws.RESTMessageV2();
rm.setLogLevel('all');

RESTMessageV2 – setMIDServer(String midServer)

Konfiguriert die REST-Nachricht für die Kommunikation über eine MID-Server.

Tabelle : 37. Parameter

Name	Typ	Beschreibung
midServer	Zeichenfolge	Name des zu verwendenden MID-Server. Ihre Instanz muss einen aktiven MID-Server mit dem angegebenen Namen haben.

Tabelle : 38. Ergebnisse

Typ	Beschreibung
void

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setMIDServer("mid_server_name");

RESTMessageV2 – setMutualAuth(String profileName)

Legt das Protokollprofil der gegenseitigen Authentifizierung für die REST-Nachricht fest.

Durch das Festlegen eines Protokollprofils mit dieser Methode wird das für den REST-Nachrichtendatensatz ausgewählte Protokollprofil überschrieben.

Tabelle : 39. Parameter

Name	Typ	Beschreibung
profileName	Zeichenfolge	Der Name des Protokollprofils für die gegenseitige Authentifizierung.

Tabelle : 40. Ergebnisse

Typ	Beschreibung
void

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setMutualAuth("mutual_auth_profile_name");

RESTMessageV2 – setQueryParameter(String name, String value)

Hängt einen Parameter an das Ende der Anforderungs-URL im Format Name=Wert an.

So hängt zum Beispiel der Code „setQueryParameter("sysparm_query","active=true^ORDERBYnumber^ORDERBYDESCcategory");“ den Text „sysparm_query=active=true^ORDERBYnumber^ORDERBYDESCcategory“ an die Anforderungs-URL an.

Tabelle : 41. Parameter

Name	Typ	Beschreibung
Name	Zeichenfolge	Name des zu übergebenden URL-Parameters.
Wert	Zeichenfolge	Wert, der dem URL-Parameter zugewiesen werden soll.

Tabelle : 42. Ergebnisse

Typ	Beschreibung
void

var sm = new sn_ws.RESTMessageV2();
//Set up message, including endpoint and authentication
sm.setQueryParameter("sysparm_query","active=true^ORDERBYnumber^ORDERBYDESCcategory");

RESTMessageV2 – setRequestBody(String body)

Legt den Textinhalt fest, der bei Verwendung der HTTP-Methoden PUT oder POST an den Webservice-Provider gesendet wird.

Wenn Sie den Textkörperinhalt mit dieser Methode festlegen, werden Variablen im Textkörper nicht durch Parameter aus dem REST-Nachrichtenfunktions-Datensatz ersetzt. Sie müssen alle Werte innerhalb des REST-Nachrichtentexts explizit definieren.

Tabelle : 43. Parameter

Name	Typ	Beschreibung
body	Zeichenfolge	Zu sendender Anforderungstext.

Tabelle : 44. Ergebnisse

Typ	Beschreibung
void

var sm = new sn_ws.RESTMessageV2("Update user","post"); //Might throw exception if message doesn't exist or not visible due to scope.
var body = "<Message body content>";
sm.setRequestBody(body);

RESTMessageV2 – setRequestBodyFromAttachment(String attachmentSysId)

Legt den Anforderungstext mithilfe eines vorhandenen Anhangdatensatzes fest.

Wenn Sie diese Funktion mit einer REST-Nachricht verwenden, die über MID-Servergesendet wird, muss der Benutzer MID-Server über alle zum Lesen von Anhangsdatensätzen erforderlichen Rollen verfügen.

Tabelle : 45. Parameter

Name	Typ	Beschreibung
attachmentSysId	Zeichenfolge	Sys_id des Anhangsdatensatzes [sys_attachment], den Sie in dieser REST-Nachricht senden möchten.

Tabelle : 46. Ergebnisse

Typ	Beschreibung
void

(function sampleRESTMessageV2() {
    try {
        var request = new sn_ws.RESTMessageV2();
        request.setHttpMethod('post');
        request.setEndpoint('<web service endpoint URL>');
        request.setRequestBodyFromAttachment('<attachment sys_id>');
        
        var response = request.execute();
        var httpResponseStatus = response.getStatusCode();
      
        gs.info("http response status_code: " + httpResponseStatus);        
    }
    catch (ex) {
        var message = ex.getMessage();
        gs.info(message);
    }
})();

RESTMessageV2 – setRequestHeader(String name, String value)

Legt einen HTTP-Header in der REST-Nachricht auf den angegebenen Wert fest.

Tabelle : 47. Parameter

Name	Typ	Beschreibung
Name	Zeichenfolge	Name des Headers.
Wert	Zeichenfolge	Wert, der dem angegebenen Header zugewiesen werden soll.

Tabelle : 48. Ergebnisse

Typ	Beschreibung
void

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setRequestHeader("Accept","Application/json");

RESTMessageV2 – setRequestorProfile(Zeichenfolge requestorContext, Zeichenfolge requestorId)

Überschreibt das standardmäßige Anfordererprofil für die REST-Nachricht, um ein OAuth-Zugriffstoken abzurufen, das einem anderen Anforderer zugeordnet ist.

Diese Methode gilt nur für REST-Nachrichten, die für die Verwendung der OAuth 2.0-Authentifizierung konfiguriert sind. Diese Methode ist optional und in den meisten Konfigurationen nicht erforderlich.

Tabelle : 49. Parameter

Name	Typ	Beschreibung
requestorContext	Zeichenfolge
requestorId	Zeichenfolge

Tabelle : 50. Ergebnisse

Typ	Beschreibung
void

RESTMessageV2 – setStringParameter(String name, String value)

Legt eine REST-Nachrichtenfunktionsvariable mit dem angegebenen Namen aus dem REST-Nachrichtendatensatz auf den angegebenen Wert fest.

Reservierte XML-Zeichen im Wert werden in die entsprechenden Escape-Zeichen umgewandelt. Verwenden Sie setStringParameterNoEscape, um eine Variable festzulegen, ohne für XML reservierte Zeichen in Escape-Zeichen umzuwandeln.

Tabelle : 51. Parameter

Name	Typ	Beschreibung
Name	Zeichenfolge	Name der REST-Nachrichtenvariablen. Dieser Parameter muss im REST-Nachrichtendatensatz definiert werden, bevor Sie ihm einen Wert zuweisen können.
Wert	Zeichenfolge	Wert, der der Variable zugewiesen werden soll.

Tabelle : 52. Ergebnisse

Typ	Beschreibung
void

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setStringParameter("s","NOW");

RESTMessageV2 – setStringParameterNoEscape(String name, String value)

Legt eine REST-Nachrichtenfunktionsvariable mit dem angegebenen Namen aus dem REST-Nachrichtendatensatz auf den angegebenen Wert fest.

Diese Methode ist äquivalent zu setStringParameter, schließt reservierte XML-Zeichen jedoch nicht in Escape-Zeichen ein.

Tabelle : 53. Parameter

Name	Typ	Beschreibung
Name	Zeichenfolge	Name der REST-Nachrichtenvariablen. Dieser Parameter muss im REST-Nachrichtendatensatz definiert werden, bevor Sie ihm einen Wert zuweisen können.
Wert	Zeichenfolge	Wert, der der Variable zugewiesen werden soll.

Tabelle : 54. Ergebnisse

Typ	Beschreibung
void

Ersetzen Sie im folgenden Beispiel REST_message_record durch den Namen des REST-Nachrichtendatensatzes Ihrer Instanz.

var sm = new sn_ws.RESTMessageV2("<REST_message_record>","get"); //Might throw exception if message doesn't exist or not visible due to scope.
sm.setStringParameterNoEscape("s","NOW");