HttpRequest - ABBYY Documentation

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

Eigenschaften

Name	Typ	Zugriff	Beschreibung
Url	string	Lesen/Schreiben	Die Ressourcen-URL.
Method	string	Lesen/Schreiben	Die Anfragemethode (zum Beispiel `GET` oder `POST`).
AuthToken	string	Lesen/Schreiben	Authentifizierungstoken, falls der externe Dienst eine Authentifizierung erfordert.
AuthScheme	string	Lesen/Schreiben	Authentifizierungsschema.
ThrowExceptionOnFailed	boolean	Lesen/Schreiben	Wenn `true` (Standard) gesetzt ist, lösen HTTP-Antwortstatuscodes außerhalb von 200–299 eine Ausnahme aus. Siehe Hinweis unten.
Timeout	number	Lesen/Schreiben	Anfrage-Timeout in Minuten. Standard ist 1 Minute.
ResponseText	string	Schreibgeschützt	Der Antworttext im Textformat.
ResponseType	string	Schreibgeschützt	Der Content-Type der Antwort (zum Beispiel `application/json`).
Status	number	Schreibgeschützt	Der 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);

​Eigenschaften

​Methoden

​SetHeader

​Send

​SetFileContent

​SetSourceFileContent

​SetStringContent

​SetUrlFormEncodedContent

​Verwandte Themen

Eigenschaften

Methoden

SetHeader

Send

SetFileContent

SetSourceFileContent

SetStringContent

SetUrlFormEncodedContent

Verwandte Themen