Rest Api Action

Rest Api Action icon

Verarbeitet RESTful-API-Aufrufe synchron. Diese Aktion ermöglicht es dem System, höhere Lasten zu verarbeiten. Sie gibt sowohl den Text als auch die Kopfzeilen für den API-Aufruf zurück. Dies erleichtert Tests und Fehlerbehebung von Skripten.

Zum Testen eines Skripts mit einer REST-API-Option und zum Anzeigen der Antwortinformationen müssen Sie das Skript ausführen. Führen Sie das Skript mit der Option Mit Trace starten aus.

Sie können synchrone REST-API-Aufrufe auch mithilfe der GetRestProxy-Funktion in einer SNIPPET-Aktion durchführen. Diese Option unterstützt nicht dieselben hohen Lasten wie die REST-API-Aktion.

Dependencies

Für die Verwendung dieser Aktion gelten einige Einschränkungen. Einschränkungen werden auf Ebene von Business Unit Eine übergeordnete organisatorische Gruppierung, die Sie für die technische Unterstützung und Abrechnung und außerdem zur Bearbeitung von globalen Einstellungen in Ihrer CXone Umgebung einsetzen können. auferlegt, sodass einer den anderen nicht beeinflussen sollte. Die Einschränkungen innerhalb der Plattform sind:

Antwortformat: Nur das JSON-Antwortformat wird unterstützt.
Neuversuche bei Fehler: Der Aktionshandler unternimmt automatisch zwei Versuche, wenn eine Fehlermeldung empfangen wird, bevor die Antwort zurückgegeben wird.
Zeitüberschreitung: Sie geben den Zeitüberschreitungswert in der Anfrage an. Der Wert kann nicht mehr als 90 Sekunden betragen.
Max. Antwortgröße: Die maximale Antwortgröße beträgt 32 KB. Dies entspricht der bestehenden Snippet-Funktion.
Drosselungsgrenzwert: Der Drosselungsgrenzwert wird durch zwei Parameter definiert:
- Max. gleichzeitige Anfragen: Standardmäßig sind bis zu 100 Anfragen gleichzeitig erlaubt. Dieser Grenzwert gilt für alle CXone-Kunden. Dies bedeutet, dass 100 gleichzeitige Anfragen zu einem viel höheren Durchsatz führen als die bestehende Snippet-Funktionalität. Wenn Sie mehr als 100 gleichzeitige Anfragen benötigen, sprechen Sie mit Ihrem CXone Account Representative über die Erhöhung des Grenzwerts für Ihre Geschäftseinheit. Es sind Sondergenehmigungen erforderlich.
- Anzahl in Warteschleife: Wenn Anfragen den Grenzwert übersteigen, werden die überzähligen Anfragen in eine Verarbeitungswarteschleife gestellt. Sobald Anfragen unter den Grenzwert sinken, werden Anfragen in der Warteschleife wieder verarbeitet.
Sicherung: Wenn Ihre angegebene URL ausgefallen oder nicht erreichbar ist, erhalten Sie möglicherweise zu viele Fehler bei Ihren Anfragen. In diesem Fall reduziert CXone vorübergehend die Ausführung aller Anfragen für ALLE URLs von der REST API-Aktion. So kann Ihre angegebene URL aus dem Fehlerzustand wiederhergestellt werden. Die Grenzwerte sind unten angegeben.
- Back-Off-Zeit oder Pausenzeit: Wenn die Fehlerrate erreicht ist, werden 30 Sekunden lang keine Anfragen mehr von der REST API-Aktion ausgeführt.
- Mindestdurchsatz: 100 Anfragen pro Sekunde. Wenn Ihre Geschäftseinheit die Mindestanzahl an Anfragen nicht ausführt, werden Ihre Anfragen weiter ausgeführt, obwohl die Anfragen fehlschlagen.
- Fehlerrate: Wenn 50 % der Anfragen innerhalb von 30 Sekunden fehlschlagen, werden Ihre Anfragen in den folgenden 30 Sekunden nicht ausgeführt. 30 Sekunden ist ein rollendes Fenster.

Input Properties

Diese Eigenschaften definieren Daten, die von der Aktion bei der Ausführung verwendet werden.

Eigenschaft	Beschreibung
Caption	Geben Sie eine kurze Phrase ein, mit der diese Aktion im Skript eindeutig identifiziert wird. Die Beschriftung wird im Skript-Arbeitsbereich unter dem Symbol der Aktion angezeigt. The default is the action name.
Verb	Unterstützt grundlegende REST-Aktionen wie GET, PUT, POST, DELETE und PATCH.
Parameters	Unterstützt die Möglichkeit, Abfrageparameter anzugeben oder Daten zu veröffentlichen. Jede Art von JSON - Jobject, Jarray, Jtoken sollte akzeptabel sein. Derzeit erfordert die Aktion, dass JSON in einer einzigen Zeile bereitgestellt wird. Die Variablenersetzung von einem String, der JSON enthält, oder das Konvertieren eines dynamischen Datentyps in JSON mithilfe der Funktionasjson() wird unterstützt. Sie können auch die Ausgabevariable resultSet(out) von einer früheren REST-API-Aktion an diese Eigenschaft übergeben.
Headers	Unterstützt die Möglichkeit, benutzerdefinierte Kopfzeilen hinzuzufügen, um die Kundenauthentifizierung zu ermöglichen (z. B. Bearertoken). Im JSON-Format ausgedrückte Schlüsselwertpaare werden akzeptiert. Für diese Aktion muss JSON in einer einzelnen Zeile bereitgestellt werden. Die Variablenersetzung von einem String, der JSON enthält, oder das Konvertieren eines dynamischen Datentyps in JSON mithilfe der Funktion asjson() wird unterstützt. Sie können auch die Ausgabevariable resultSet(out) von der vorherigen REST API-Aktion an diese Eigenschaft übergeben. Wichtig Wenn für Ihren benutzerdefinierten URL-Endpunkt unterschiedliche Header erforderlich sind, muss er in dieser Eigenschaft angegeben werden. Um die Funktionsparität mit der vorhandenen Snippet-Aktion zu behalten, fügt CXone die folgenden Kopfzeilen hinzu. {"Accept":"application/json", "Content-Type" :"application/x-www-form-urlencoded"}
Command	Die einzige Option ist MakeRestRequest, die bei Verwendung in einer Snippetaction- auf dieselbe Weise funktioniert. Zukünftige Entwicklungen können zusätzliche Befehle bieten, die die Snippet-Aktion bietet.
TimeOutInMilliSeconds	Ermöglicht die Angabe und Berücksichtigung eines Timeouts des REST-Aufrufs. Muss kleiner als 90 Sekunden (90.000 Millisekunden) sein. Wenn kein Timeout angegeben ist, ist die Standardeinstellung 10 Sekunden (10.000 Millisekunden).
Service Address	Ermöglicht die Angabe einer benutzerdefinierten URL, einschließlich der Möglichkeit, Abfrageparameter für ein GET anzugeben. Die variable Substitution wird ebenfalls unterstützt.

Ausgabeeigenschaften

Diese Eigenschaften enthalten Variablen mit Daten, die bei der Ausführung der Aktion zurückgegeben werden. Sie stehen zu Referenzzwecken und zur Verwendung nach Abschluss der Aktion zur Verfügung.

Eigenschaft	Beschreibung
resultSet(out)	Diese Eigenschaft enthält die Informationen, die von der API zurückgegeben wurden, die unter Dienstadresse angegeben ist. Im Trace-Fenster von Studio erscheint diese Angabe zu Anzeigezwecken als Dynamic Object. Sie können dieses resultSet bei Bedarf auch unverändert an die Kopfzeile und die Parameter weitergeben.
errorArgList(out)	Fehlerbedingungen haben aus Kompatibilitätsgründen ein Objekt wie der REST-Proxy. Unterstützt den DynamicData-Typ.

Bedingungen für Ergebnisverzweigungen

Mit Bedingungen für Ergebnisverzweigungen können Sie in Ihrem Skript Verzweigungen erstellen, die für unterschiedliche Ergebnisse bei der Ausführung einer Aktion vorgesehen sind.

Bedingung	Beschreibung
Throttle	Genommener Pfad, wenn zu viele Anforderungen innerhalb kurzer Zeit ausgeführt werden. Weitere Informationen finden Sie in den folgenden Einschränkungen.
InvalidInput	Genommener Pfad, wenn eine ungültige Eingabe gefunden wird oder ein Timeout-Fehler auftritt. Jeder Parameter wird beim Speichern des Skripts überprüft.
Failure	Genommener Pfad, wenn ein Fehler oder eine Ausnahme innerhalb der NICE CXone auftritt, die die Anforderung ausführt.Anwendung
Error	Genommener Pfad, wenn der Remote-Kundenendpunkt einen http-Fehlercode zurückgibt.
Default	Genommener Pfad, wenn die Antwort nicht innerhalb von 90 Sekunden empfangen wird.
Success	Verwendeter Pfad, wenn die Aktion ohne Fehler abgeschlossen wurde und alle API-Aufrufe oder Datenrückgaben erfolgreich waren (2xx Antwortcodes).

Other Options

Sie können externe RESTful API-Anfragen ersetzen, die derzeit in der Snippetaction- ausgeführt werden.