Erstellen Sie eine REST-Webservice-Aktivität

Verwenden Sie dieses Verfahren, um einen anwenderdefinierten REST-Webservice zu erstellen OrchestrationAktivität.

Vorbereitungen

Erforderliche Rolle: Web_Service_admin, activity_admin, activity_creator

Warum und wann dieser Vorgang ausgeführt wird

So erstellen und verwenden Sie eine REST-Webservice-Workflow-Aktivität:

• Erstellen Sie ein Erstellen Sie eine REST-Nachricht Wenn noch kein entsprechender konfiguriert ist.
• Weisen Sie die Rolle „Web_Service_admin“ jedem Anwender zu, der eine anwenderdefinierte REST-Aktivität erstellen oder bearbeiten muss.
• Bestimmen Sie eine Anwendung, oder Anwendungsbereich , Für diese Aktivität.
• Bestimmen Sie Erstellen Sie eine REST-Nachricht Für die Aktivität zu verwenden. Verwenden Sie diesen Wert, um den in der REST-Nachricht konfigurierten Endpunkt zu überschreiben.
• Erstellen Sie optional Anmeldeinformationen für Standardauthentifizierung . Verwenden Sie diesen Wert, um die in der SOAP-Nachricht konfigurierten Anmeldeinformationen zu überschreiben.

Prozedur

1. Erstellen Sie ein Anwenderdefinierte Aktivität .
   Mit dieser Aktion wird eine anwenderdefinierte Aktivität mithilfe einer Vorlage erstellt.
2. Nach dem Einrichten Allgemeine Eigenschaften Und Eingabevariablen werden erstellt , Konfigurieren Sie den REST-Webservice-Ausführungsbefehl.

   Option	Bezeichnung
   Ordnen Sie die Eingabevariablen zu	Verwenden Sie die von Ihnen erstellten Variablen, um den Befehl zu konfigurieren, den Orchestration ausführt.
   REST-Nachricht	Name einer vorhandenen REST-Nachricht, die in dieser Aktivität verwendet werden soll.
   REST-Nachrichtenfunktion	REST-Nachrichtenfunktion, die für diese Aktivität verwendet werden soll.
   Endpunkt	Endpunkt-URL für den REST-Webservice, den diese Aktivität verwendet. Geben Sie einen Endpunkt in dieses Feld ein, um den in der REST-Nachricht konfigurierten Endpunkt zu überschreiben. Klicken Sie auf die Sperre, um das Eingabefeld zu öffnen.
   Variablenersetzungen	Name-Wert-Paare, die an den REST-Endpunkt übergeben werden sollen. Sie können diese Parameter manuell erstellen oder Eingabevariablen in die Parameterfelder ziehen und dann einen Wert zuweisen. Parameter, die in der verwendeten REST-Nachricht definiert sind ${} Können Daten aus dieser Aktivitätsvorlage zugewiesen werden. Verwenden Sie Zusätzliches Attribut Spalte, um das System so zu konfigurieren, dass der Text nicht mit einem Escape-Zeichen versehen wird. Standardmäßig wird der an die REST-Nachricht gesendete Text mit Escape-Zeichen versehen. Wenn die Anwender Variablen mit angegeben haben Variablenersetzung in ausgehenden REST-Nachrichten In der REST-Nachricht dann Name Spalte wird automatisch ausgefüllt.
   Zusätzliche Header	Zusätzliche HTTP-Header-Parameter für die ausgewählte REST-Nachricht. Sie können diese Werte auch verwenden, um Parameter zu überschreiben, die von der REST-Nachricht geerbt wurden.
   Zusätzliche Abfrageparameter	Zusätzliche Abfrageparameter für die ausgewählte REST-Nachricht. Sie können diese Werte auch verwenden, um Parameter zu überschreiben, die von der REST-Nachricht geerbt wurden.
   MID-Server verwenden	Kontrollkästchen, das bestimmt, ob ein MID-Server zum Aufrufen des REST-Webservice verwendet werden soll. Hinweis: Wenn die REST-Webservice-Nachrichtenfunktion einen MID-Server definiert, wird dieser MID-Server anstelle des hier ausgewählten Servers verwendet.
   Erforderliche MID-Serverfähigkeiten	MID-Server mit entsprechendem MID-Serverfähigkeiten Für die Verbindung mit dem REST-Endpunkt. Standardmäßig wählt das System einen MID-Server mit REST-Fähigkeiten aus. Dieses Feld ist verfügbar, wenn Verwenden Sie den MID-Server Kontrollkästchen ist aktiviert.
   Zeitüberschreitung	Zulässige Dauer der REST-Webserviceanforderung vor Zeitüberschreitung in Sekunden. Der Standardwert ist 10 .
   Authentifizierung	Bestimmt, welche Art von Authentifizierung für den Endpunkt erforderlich ist. Die Optionen sind: Vorhandene Anmeldeinformationen in REST-Nachricht verwenden : Verwendet Anmeldeinformationsdefinitionen aus der REST-Nachrichtendefinition. Überschreiben Sie mit Anmeldeinformationen für die Standardauthentifizierung : Verwendet Aktivieren Sie die Standardauthentifizierung für ausgehende SOAP Anmeldeinformationen zum Überschreiben der Anmeldeinformationen in der REST-Nachrichtendefinition. Anmeldeinformationen für die Standardauthentifizierung müssen bereitgestellt werden, bevor sie zur Auswahl verfügbar sind. Überschreiben Sie mit Anmeldeinformationen für die Zertifikatauthentifizierung : Verwendet ein Zertifikat, z. B. einen privaten Schlüssel, um die Anmeldeinformationen in der REST-Nachrichtendefinition zu überschreiben. Überschreiben Sie mit Anmeldeinformationen für Standard- und Zertifikatauthentifizierung : Verwendet sowohl die Standardauthentifizierung als auch die Zertifikatauthentifizierung, um die Anmeldeinformationen in der REST-Nachrichtendefinition zu überschreiben. Überschreiben Sie mit Anmeldeinformationen für die OAuth-Authentifizierung : Verwendet OAuth 2,0 Anmeldeinformationen zum Überschreiben der Anmeldeinformationen in der REST-Nachrichtendefinition. Die für diese Aktivität ausgewählte REST-Nachricht muss Folgendes haben OAuth 2,0-Tutorial: Erstellen Sie eine REST-Nachricht Auf festlegen OAuth 2,0 Und ist OAuth-Profile und -Umfänge Entsprechend konfiguriert.
   Anmeldeinformationen	Erforderliche Anmeldeinformationen für Standardauthentifizierung des REST-Endpunkts. Dieses Feld ist verfügbar, wenn Überschreiben Sie mit Anmeldeinformationen für die Standardauthentifizierung Ist in ausgewählt Authentifizierung Feld. Nur Anmeldeinformationen für Standardauthentifizierung werden in der Auswahlliste angezeigt, die Anmeldeinformationen enthält, die in der Instanz gespeichert sind, und Anmeldeinformations-IDs aus einem externen Speichersystem. Wenn Sie Anmeldeinformationen verwenden, die in einem CyberArk Safe gespeichert sind, können Sie den in der MID-Server-Konfigurationsdatei definierten Standardsafe überschreiben. Siehe Konfigurieren Sie den MID-Server für CyberArk Für Details. Fügen Sie der Anmeldeinformations-ID den Namen eines anderen Safe als Präfix hinzu, getrennt durch einen Doppelpunkt. Beispiel: newsafe:orch-test-f5.
   Protokollprofil	Zu verwendende Zertifikatauthentifizierung. Dieses Feld ist verfügbar, wenn die Auswahl in Authentifizierung Sind beide Überschreiben Sie mit Anmeldeinformationen für die Zertifikatauthentifizierung Oder Überschreiben Sie mit Anmeldeinformationen für Standard- und Zertifikatauthentifizierung .
   OAuth-Profil	Profil für den OAuth-Anbieter für diese REST-Nachricht. Siehe Geben Sie ein OAuth-Profil an Für weitere Informationen.

   Hinweis:

   Sie können Parameterwerte in einer Testnutzlast Variablen in zuordnen Ausgaben Automatisch Registerkarte. Siehe Ausgabevariablen automatisch zuordnen .

Nächste Maßnahme

Schließen Sie die Erstellung Ihrer Rest-Webservice-Aktivität bis ab Ausgabevariablen werden erstellt , Analyseregel wird erstellt , Oder Bedingungen . Weitere Informationen finden Sie unter Erstellen Sie anwenderdefinierte Aktivitäten Thema, um Ihre Vorlagenoptionen zu erfahren.

REST-Aktivitätsausgabevariablen automatisch zuordnen

Die ServiceNowMit dem Aktivitäts-Designer können Sie Parameterwerte in einer REST-Testnutzlast Variablen in zuordnen Ausgaben Phase automatisch.

Vorbereitungen

Erforderliche Rolle: Web_Service_admin, activity_admin, activity_creator

Warum und wann dieser Vorgang ausgeführt wird

Hinweis:

Sie können Eingabevariablen aus jeder Phase im Aktivitätendesigner testen, wenn Sie genügend Informationen für die Orchestration bereitgestellt haben, um den Endpunkt zu kontaktieren und Daten zurückzugeben. In der Regel wird Ausführungsbefehl Phase ist der Punkt, an dem Ihre Eingaben zum Testen bereit sind.

Prozedur

1. Fahren Sie im Aktivitätendesigner mit fort Ausführungsbefehl Phase.
2. Definieren Sie bei Bedarf einen entsprechenden MID-Server.
   Der Test schlägt fehl, wenn der MID-Server nicht gefunden werden kann oder wenn er keine Verbindung zum Ziel herstellen kann.
3. Klicken Sie Auf Testaktivität Zum Testen der Eingabeparameter.
   Wenn Sie tatsächliche Werte für die Parameter und Felder hinzugefügt haben, führt das System diese Werte für das angegebene Ziel aus und gibt die resultierende Nutzlast zurück. Wenn Sie Eingabevariablen Feldern und Parametern zugeordnet haben, zeigt das System ein Dialogfeld zum Zuweisen von Testwerten zu diesen Variablen an.
4. Geben Sie Testwerte an, falls angefordert, und klicken Sie auf OK Zum Anzeigen der Nutzlast.
   Die gesamte Nutzlast wird in angezeigt Rohausgabe Registerkarte des Antwortformulars.

   

5. Wählen Sie eine dieser Optionen für die automatische Zuordnung aus.
   • Automatisch lokal zuordnen : Ordnet Werte direkt einer lokalen Variable zur Verwendung innerhalb der Aktivität zu.
   • Automatisch der Ausgabe zuordnen : Ordnet der Ausgabevariablen Werte direkt Werte zu, um sie an andere Aktivitäten im Workflow zu übergeben. Durch die automatische Zuordnung zu einer Ausgabevariable wird ein Array von Objekten erstellt, die jeweils die Spaltennamen aus dem Abfrageergebnis enthalten.

REST-Vorlagenausführungsparameter

Sie verwenden Ausführungsparameter, um das Eingabeprozessskript in zu erstellen Vorverarbeitung Formular des Aktivitätendesigners.

Beschreibungen der REST-Webservice-Befehlsfelder finden Sie unter Konfigurieren Sie den REST-Ausführungsbefehl.

Hinweis:

Sie müssen verwenden ExecutionParameter. Präfix mit allen Variablen in dieser Tabelle.

Tabelle : 1. REST-Vorlagenausführungsparameter

Name	Variable	Typ	Nutzung
Webservicenachricht	Web_Service_message	Referenz	Die sys_ID der entsprechenden Webservicenachricht.
Webservice-Nachrichtenfunktion	web_service_message_function	Referenz	Die sys_ID der REST-Nachrichtenfunktion.
Webservice-Endpunkt	Web_Service_Endpoint	Zeichenfolge	URL des REST-Endpunkts.
Parameter	parameters	Array von JavaScript-Objekten	Array von JavaScript-Objekten, ausgedrückt mit ExecutionParameter. Präfix. Anweisungen zum Erstellen von Arrays mit diesem Parameter finden Sie unter Erstellen Sie ein JavaScript-Array in einer REST-Vorlage.
Mid-Server verwenden	use_mid_server	Boolean	Wählt aus, ob der MID-Server verwendet werden soll. Ein Wert von Wahr Verwendet den MID-Server und einen Wert von Falsch Verwendet nicht den MID-Server.
MidCapabilities	MidCapabilities	Zeichenfolge (kommagetrennt)	Liste der Verweise auf erforderliche MID-Serverfähigkeiten.
Zeitüberschreitung	Zeitüberschreitung	Zeichenfolge	Zulässige Zeitüberschreitungsdauer, ausgedrückt in Sekunden.
Wertfähigkeiten	Wertfähigkeiten	Array von Hashmap	Fähigkeitswerte, die zum Auswählen des MID-Servers verwendet werden. Weitere Informationen finden Sie unter MID-Serverfähigkeiten . Verwenden Sie dieses Beispiel, um die MID-Serverauswahl anzupassen, wenn zusätzliche Fähigkeiten vorhanden sind, die nach Wert zugewiesen werden: var valueCapability = {'NEW_MID_CAPABIILTY':'NEW_MID_CAPABILITY_VALUE'}; executionParam.valueCapabilities.push(valueCapability);
Auth.typ	Auth-type	Boolean	Typ der zu verwendenden Anmeldeinformationen. Die Auswahlmöglichkeiten sind: basic_auth_pick_credentials Use_existing_credentials
Anmeldeinformationen	Anmeldeinformationen	Referenz	Enthält die Anmeldeinformationen, die für diese REST-Nachricht verwendet werden sollen, wenn Auth_type Ausgewählt ist basic_auth_pick_credentials .

Erstellen Sie ein JavaScript-Array in einer REST-Vorlage

Dies sind Anweisungen zum Erstellen von JavaScript-Arrays mit REST-Ausführungsparametern.

Vorbereitungen

Erforderliche Rolle: Web_Service_admin, activity_admin, activity_creator

Warum und wann dieser Vorgang ausgeführt wird

Um dem Array des Parameters weitere Name-Wert-Paare hinzuzufügen, fügen Sie die Werte dem vorhandenen Array an.

Prozedur

1. Erstellen Sie ein JavaScript-Objekt mit der folgenden Syntax, und fügen Sie es zu hinzu ExecutionParam.Parameter Array:

   var newParameter = {"name":"parameterName","value":"parameterValue","additional_attribute":"none"}; 
   executionParam.parameters.push(newParameter);

   Durch Hinzufügen des neuen Parameter-JavaScript-Objekts zum Array stellen Sie sicher, dass alle Elemente, die bereits im Array verfügbar sind, nicht betroffen sind.

2. Stellen Sie sicher, dass Sie den Wert in festlegen Zusätzliches Attribut Spalte in REST-Nachrichtenparameter Eingabefeld bis Text nicht mit Escape-Zeichen versehen .

   In diesem Fall weist das System den für angegebenen Wert nicht mit einem Escape-Zeichen auf Wert Attribut. Ein Beispiel hierfür ist:

   var newParameter = {"name":"parameterName","value":"parameterValue","additional_attribute":"do_not_escape_text"}; 
   executionParam.parameters.push(newParameter);

   Hinweis:

   Wenn der Wert für Additional_Attribute Feld ist Keine , Wird dann vom System der von angegebene Wert mit Escape-Zeichen versehen Wert Attribut. Im ersten Beispiel ParameterWert Ist mit Escape versehen.

Nachverarbeitungsparameter der REST-Vorlage

Verwenden Sie diese Parameter, um ein Nachverarbeitungsskript zu erstellen.

Tabelle : 2. Nachverarbeitungsparameter des Aktivitätendesigners

Name	Variable	Typ	Nutzung
Statuscode	status_code	Ganzzahl	Enthält den Statuscode, der vom REST-Webservice zurückgegeben wird.
Header	header	Hashmap des JavaScript-Objekts	Hashmap von Schlüssel-Wert-Paaren, die den an den Webservice übergebenen Headerwerten zugeordnet sind. Sie können mit auf jeden Wert zugreifen ExecutionResult.Header[Schlüsselname] .
Textkörper	body	Zeichenfolge	Enthält einen Zeichenfolgenwert, der die Ausgabe der REST-Nachricht darstellt
Fehler	Fehler	Zeichenfolge	Gibt die Fehlerzeichenfolge vom REST-Webservice zurück, es sei denn, es liegen keine Fehler vor. In diesem Fall wird die Zeichenfolge zurückgegeben Null .

Konfigurieren Sie den REST-Ausführungsbefehl

Verwenden Sie die von Ihnen erstellten Eingabevariablen, um den Befehl zu konfigurieren, den Orchestration auf dem REST-Endpunkt ausführt.

Vorbereitungen

Erstellen Sie die Eingabevariablen, die Sie benötigen, in Eingaben Formular, bevor Sie mit fortfahren können Ausführungsbefehl Phase.

Erforderliche Rolle: Web_Service_admin, activity_admin, activity_creator

Hinweis:

Sie können die REST-Verbindung zwischen dem MID-Server und dem Endpunkt testen, ohne die Aktivität in einem Workflow-Kontext ausführen zu müssen. Weitere Informationen finden Sie unter Testvorlagenausgaben .

Prozedur

1. Ziehen Sie Variablen aus der Liste der Eingaben, und legen Sie sie in Befehlsfelder ab.
   Das System formatiert die Variable in der richtigen Syntax für den Befehl.

   Abbildung : 1. REST-Ausführung Befehl

   

2. Füllen Sie die in der Tabelle angezeigten Felder aus.

   Tabelle : 3. REST-Ausführungsbefehlfelder

   Feld	Beschreibung
   Eingabe	Eingabevariablengenerator. Erstellen Sie EingabevariablenZum Zuordnen zu verfügbaren Feldern.
   REST-Nachricht	Name einer vorhandenen REST-Nachricht, die in dieser Aktivität verwendet werden soll. Anwender müssen über die Rolle „Web_Service_admin“ verfügen, um dieses Feld zu konfigurieren.
   REST-Nachrichtenfunktion	REST-Nachrichtenfunktion, die für diese Aktivität verwendet werden soll. Anwender müssen über die Rolle „Web_Service_admin“ verfügen, um dieses Feld zu konfigurieren.
   Endpunkt	Endpunkt-URL für den REST-Webservice, den diese Aktivität verwendet. Geben Sie einen Endpunkt in dieses Feld ein, um den in der REST-Nachricht konfigurierten Endpunkt zu überschreiben. Klicken Sie auf die Sperre, um das Eingabefeld zu öffnen.
   Variablenersetzungen	Name-Wert-Paare, die an den REST-Endpunkt übergeben werden sollen. Sie können diese Parameter manuell erstellen oder Eingabevariablen per Drag-and-Drop in die Parameterfelder ziehen und dann einen Wert zuweisen. Parameter, die in der verwendeten REST-Nachricht definiert sind ${} Können Daten aus dieser Aktivitätsvorlage zugewiesen werden. Verwenden Sie Zusätzliches Attribut Spalte, um das System so zu konfigurieren, dass der Text nicht mit einem Escape-Zeichen versehen wird. Standardmäßig wird der an die REST-Nachricht gesendete Text mit Escape-Zeichen versehen. Die Name Spalte wird automatisch ausgefüllt, wenn die Anwender Variablen mit angegeben haben Variablenersetzung in ausgehenden REST-Nachrichten In der REST-Nachricht.
   Zusätzliche Header	Zusätzliche HTTP-Header-Parameter für die ausgewählte REST-Nachricht. Sie können diese Werte auch verwenden, um Parameter zu überschreiben, die von der REST-Nachricht geerbt wurden.
   Zusätzliche Abfrageparameter	Zusätzliche Abfrageparameter für die ausgewählte REST-Nachricht. Sie können diese Werte auch verwenden, um Parameter zu überschreiben, die von der REST-Nachricht geerbt wurden.
   MID-Server verwenden	Kontrollkästchen, das bestimmt, ob ein MID-Server zum Aufrufen des REST-Webservice verwendet werden soll. Hinweis: Wenn die REST-Webservice-Nachrichtenfunktion einen MID-Server definiert, wird dieser MID-Server anstelle des hier ausgewählten Servers verwendet.
   Erforderliche MID-Serverfähigkeiten	MID-Server mit entsprechendem MID-Serverfähigkeiten Für die Verbindung mit dem REST-Endpunkt. Standardmäßig wählt das System einen MID-Server mit REST-Fähigkeiten aus. Dieses Feld ist verfügbar, wenn Verwenden Sie den MID-Server Kontrollkästchen ist aktiviert.
   Zeitüberschreitung	Zulässige Dauer der REST-Webserviceanforderung vor Zeitüberschreitung in Sekunden. Der Standardwert ist 10 .
   Authentifizierung	Bestimmt, welche Art von Authentifizierung für den Endpunkt erforderlich ist. Die Optionen sind: Vorhandene Anmeldeinformationen in REST-Nachricht verwenden : Verwendet Anmeldeinformationsdefinitionen aus der REST-Nachrichtendefinition. Überschreiben Sie mit Anmeldeinformationen für die Standardauthentifizierung : Verwendet Aktivieren Sie die Standardauthentifizierung für ausgehende SOAP Anmeldeinformationen zum Überschreiben der Anmeldeinformationen in der REST-Nachrichtendefinition. Anmeldeinformationen für die Standardauthentifizierung müssen bereitgestellt werden, bevor sie zur Auswahl verfügbar sind. Überschreiben Sie mit Anmeldeinformationen für die Zertifikatauthentifizierung : Verwendet ein Zertifikat, z. B. einen privaten Schlüssel, um die Anmeldeinformationen in der REST-Nachrichtendefinition zu überschreiben. Überschreiben Sie mit Anmeldeinformationen für Standard- und Zertifikatauthentifizierung : Verwendet sowohl die Standardauthentifizierung als auch die Zertifikatauthentifizierung, um die Anmeldeinformationen in der REST-Nachrichtendefinition zu überschreiben. Überschreiben Sie mit Anmeldeinformationen für die OAuth-Authentifizierung : Verwendet OAuth 2,0 Anmeldeinformationen zum Überschreiben der Anmeldeinformationen in der REST-Nachrichtendefinition. Die für diese Aktivität ausgewählte REST-Nachricht muss Folgendes haben OAuth 2,0-Tutorial: Erstellen Sie eine REST-Nachricht Auf festlegen OAuth 2,0 Und ist OAuth-Profile und -Umfänge Entsprechend konfiguriert.
   Anmeldeinformationen	Erforderliche Anmeldeinformationen für Standardauthentifizierung des REST-Endpunkts. Dieses Feld ist verfügbar, wenn Überschreiben Sie mit Anmeldeinformationen für die Standardauthentifizierung Ist in ausgewählt Authentifizierung Feld. Nur Anmeldeinformationen für Standardauthentifizierung werden in der Auswahlliste angezeigt, die Anmeldeinformationen enthält, die in der Instanz gespeichert sind, und Anmeldeinformations-IDs aus einem externen Speichersystem. Wenn Sie Anmeldeinformationen verwenden, die in einem CyberArk Safe gespeichert sind, können Sie überschreiben Konfigurieren Sie den MID-Server für CyberArk Definiert in der MID-Server-Konfigurationsdatei, indem der Anmeldeinformations-ID der durch einen Doppelpunkt getrennten Namen eines anderen Safe als Präfix hinzugefügt wird. Beispiel: newsafe:orch-test-f5.
   Protokollprofil	Zu verwendende Zertifikatauthentifizierung. Dieses Feld ist verfügbar, wenn die Auswahl in Authentifizierung Feld ist entweder Überschreiben Sie mit Anmeldeinformationen für die Zertifikatauthentifizierung Oder Überschreiben Sie mit Anmeldeinformationen für Standard- und Zertifikatauthentifizierung .
   OAuth-Profil	Profil für den OAuth-Anbieter für diese REST-Nachricht. Siehe Geben Sie ein OAuth-Profil an Für weitere Informationen.

3. Klicken Sie auf Speichern.
4. Klicken Sie Auf Fahren Sie Fort Um zu weiterzufahren Ausgaben Phase.