Vai al contenuto principale

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 invia richieste HTTP contenenti dati application/x-www-form-urlencoded, di testo o binari a servizi esterni.

Proprietà

NomeTipoAccessoDescrizione
UrlstringLettura/scritturaL’URL della risorsa.
MethodstringLettura/scritturaIl tipo di richiesta (ad esempio, GET o POST).
AuthTokenstringLettura/scritturaToken di autenticazione, se il servizio esterno richiede l’autenticazione.
AuthSchemestringLettura/scritturaSchema di autenticazione.
ThrowExceptionOnFailedbooleanLettura/scritturaSe è true (impostazione predefinita), i codici di stato della risposta HTTP al di fuori dell’intervallo 200–299 generano un’eccezione. Vedi la nota seguente.
TimeoutnumberLettura/scritturaTimeout della richiesta in minuti. Il valore predefinito è 1 minuto.
ResponseTextstringSola letturaIl corpo della risposta in formato testo.
ResponseTypestringSola letturaIl tipo di contenuto della risposta (ad esempio, application/json).
StatusnumberSola letturaIl codice di stato della risposta HTTP restituito dal servizio esterno.
Quando ThrowExceptionOnFailed è false, non vengono generate eccezioni per le risposte 4xx/5xx — controlla Status per verificare direttamente il codice di stato HTTP. Una risposta con un codice di errore significa che il servizio esterno è raggiungibile e sta rispondendo. Gli errori relativi alla disponibilità del servizio o ai problemi di connessione generano sempre un’eccezione del programma, indipendentemente da questa proprietà — in questi casi non è disponibile alcun codice di stato HTTP.
Se ThrowExceptionOnFailed è true e la risposta restituisce un codice di errore, la transaction viene interrotta e il messaggio di errore viene visualizzato in Skill Monitor.
Il valore di Timeout non può superare il limite di Runtime dello script (600 secondi).

Metodi

SetHeader

void SetHeader(string name, string value);
Imposta un’intestazione HTTP aggiuntiva per la richiesta. Va chiamato una volta per ogni intestazione.

Invia

void Send();
Invia la richiesta HTTP.

SetFileContent

void SetFileContent(DocumentExportResult documentExportResult, string mediaType?);
void SetFileContent(BinaryFile binaryFile, string mediaType?);
Inizializza un corpo della richiesta HTTP basato su file. Il tipo di contenuto viene rilevato in base all’estensione del file (ad esempio, application/json, application/pdf). Per specificarlo manualmente, passa mediaType.
  • Il primo overload invia i dati esportati (da Document.Exports) come file.
  • Il secondo overload invia dati binari: un’immagine sorgente acquisita al momento della creazione della transaction oppure un’immagine proveniente da un field di tipo Picture.

SetSourceFileContent

void SetSourceFileContent(string mediaType?);
Inizializza una richiesta con dati binari usando l’immagine sorgente importata al momento della creazione della transaction. Il tipo di contenuto viene rilevato dall’estensione del file. Se necessario, puoi sovrascriverlo con mediaType.
SetSourceFileContent è deprecato — accede solo al primo file di una transaction. Usa invece SetFileContent.

SetStringContent

void SetStringContent(string content, ContentEncoding contentEncoding?, string mediaType?);
Inizializza un corpo della richiesta HTTP basato su string. Per impostazione predefinita, usa Content-Type: application/json e la codifica UTF-8. È possibile sostituire uno dei due utilizzando i parametri facoltativi.

SetUrlFormEncodedContent

void SetUrlFormEncodedContent(any content);
Inizializza il corpo della richiesta HTTP a partire da un oggetto JavaScript e lo codifica come application/x-www-form-urlencoded. L’oggetto deve essere un semplice insieme di coppie proprietà/valore:
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

Oggetto globale per dati della transaction, richieste HTTP e segreti.

MultipartFormDataRequest

Esegui richieste HTTP multipart/form-data dagli script dell’Attività personalizzata.

BinaryFile

Dati di file in formato binario, in genere l’immagine sorgente prima della pre-elaborazione.

DocumentExportResult

Accedi ai file di documento esportati (JSON, PDF, immagini) da uno script.

ContentEncoding

Tipi di codifica disponibili per le richieste HTTP basate su stringhe.

Modello a oggetti

Riferimento completo agli oggetti JavaScript per gli script dell’Attività personalizzata.