Zum Hauptinhalt springen

Documentation Index

Fetch the complete documentation index at: https://docs.abbyy.com/llms.txt

Use this file to discover all available pages before exploring further.

HttpRequest sendet HTTP-Anfragen mit application/x-www-form-urlencoded-Daten, Text oder Binärdaten an externe Dienste.”

Eigenschaften

NameTypZugriffBeschreibung
UrlstringLesen/SchreibenDie Ressourcen-URL.
MethodstringLesen/SchreibenDie Anfragemethode (zum Beispiel GET oder POST).
AuthTokenstringLesen/SchreibenAuthentifizierungstoken, falls der externe Dienst eine Authentifizierung erfordert.
AuthSchemestringLesen/SchreibenAuthentifizierungsschema.
ThrowExceptionOnFailedbooleanLesen/SchreibenWenn true (Standard) gesetzt ist, lösen HTTP-Antwortstatuscodes außerhalb von 200–299 eine Ausnahme aus. Siehe Hinweis unten.
TimeoutnumberLesen/SchreibenAnfrage-Timeout in Minuten. Standard ist 1 Minute.
ResponseTextstringSchreibgeschütztDer Antworttext im Textformat.
ResponseTypestringSchreibgeschütztDer Content-Type der Antwort (zum Beispiel application/json).
StatusnumberSchreibgeschütztDer HTTP-Antwortstatuscode des externen Dienstes.
Wenn ThrowExceptionOnFailed auf false gesetzt ist, werden für 4xx/5xx-Antworten keine Ausnahmen ausgelöst — prüfen Sie Status, um den HTTP-Statuscode selbst zu ermitteln. Eine Antwort mit einem Fehlercode bedeutet, dass der externe Dienst erreichbar ist und antwortet. Fehler im Zusammenhang mit der Verfügbarkeit des Dienstes oder Verbindungsfehler lösen unabhängig von dieser Eigenschaft immer eine Ausnahme aus — in diesen Fällen ist kein HTTP-Statuscode verfügbar.
Wenn ThrowExceptionOnFailed auf true gesetzt ist und die Antwort einen Fehlercode enthält, wird der Vorgang unterbrochen und die Fehlermeldung erscheint im Skill Monitor.
Der Wert von Timeout darf das Skriptlaufzeitlimit (600 Sekunden) nicht überschreiten.

Methoden

SetHeader

void SetHeader(string name, string value);
Legt einen zusätzlichen HTTP-Header für die Anforderung fest. Einmal pro Header aufrufen.

Send

void Send();
Sendet die HTTP-Anfrage.

SetFileContent

void SetFileContent(DocumentExportResult documentExportResult, string mediaType?);
void SetFileContent(BinaryFile binaryFile, string mediaType?);
Initialisiert einen dateibasierten HTTP-Request-Body. Der Content-Type wird anhand der Dateierweiterung erkannt (zum Beispiel application/json, application/pdf). Zum Überschreiben übergeben Sie mediaType.
  • Die erste Überladung sendet exportierte Daten (aus Document.Exports) als Datei.
  • Die zweite Überladung sendet Binärdaten — entweder ein Quellbild aus der Erstellung des Vorgangs oder ein Bild aus einem Feld vom Typ Picture.

SetSourceFileContent

void SetSourceFileContent(string mediaType?);
Initialisiert eine Binärdatenanforderung mit dem Quellbild, das beim Erstellen des Vorgangs importiert wurde. Der Content-Type wird anhand der Dateierweiterung erkannt. Falls nötig, überschreiben Sie ihn mit mediaType.
SetSourceFileContent ist veraltet — es greift nur auf die erste Datei in einem Vorgang zu. Verwenden Sie stattdessen SetFileContent.

SetStringContent

void SetStringContent(string content, ContentEncoding contentEncoding?, string mediaType?);
Initialisiert einen stringbasierten Request-Body. Standardmäßig werden Content-Type: application/json und UTF-8-Codierung verwendet. Sie können beides mit den optionalen Parametern überschreiben.

SetUrlFormEncodedContent

void SetUrlFormEncodedContent(any content);
Initialisiert den Request-Body aus einem JavaScript-Objekt und kodiert ihn als application/x-www-form-urlencoded. Das Objekt sollte eine einfache Menge von Eigenschafts-/Wert-Paaren sein:
var form = {};
form.grant_type = "password";
form.scope = "openid permissions";
form.client_id = "value of client_id";
form.client_secret = "value of client_secret";
form.password = "Password";
form.username = "User Name";
request.SetUrlFormEncodedContent(form);

Context

Globales Objekt für Vorgangsdaten, HTTP-Anfragen und Secrets.

MultipartFormDataRequest

Multipart/form-data-HTTP-Anfragen aus Skripten benutzerdefinierter Aktivitäten senden.

BinaryFile

Dateidaten im Binärformat — in der Regel das Quellbild vor der Vorverarbeitung.

DocumentExportResult

Zugriff auf exportierte Dokumentdateien (JSON, PDF, Bilder) aus einem Skript.

ContentEncoding

Verfügbare Codierungstypen für stringbasierte HTTP-Anfragen.

Objektmodell

Vollständige JavaScript-Objektreferenz für Skripte benutzerdefinierter Aktivitäten.