Saltar al contenido principal

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 envía solicitudes HTTP con contenido application/x-www-form-urlencoded, de texto o datos binarios a servicios externos.

​
Propiedades

NameTipoAccesoDescripción
UrlstringLectura y escrituraLa URL del recurso.
MethodstringLectura y escrituraEl tipo de solicitud (por ejemplo, GET o POST).
AuthTokenstringLectura y escrituraToken de autenticación si el servicio externo requiere autenticación.
AuthSchemestringLectura y escrituraEsquema de autenticación.
ThrowExceptionOnFailedbooleanLectura y escrituraSi es true (valor predeterminado), los códigos de estado de respuesta HTTP fuera del rango 200–299 generan una excepción. Consulte la nota siguiente.
TimeoutnumberLectura y escrituraTiempo de espera de la solicitud en minutos. El valor predeterminado es 1 minuto.
ResponseTextstringDe solo lecturaEl cuerpo de la respuesta en formato de texto.
ResponseTypestringDe solo lecturaEl tipo de contenido de la respuesta (por ejemplo, application/json).
StatusnumberDe solo lecturaEl código de estado de respuesta HTTP del servicio externo.
Cuando ThrowExceptionOnFailed es false, no se generan excepciones para respuestas 4xx/5xx; revise Status para comprobar usted mismo el código de estado HTTP. Una respuesta con un código de error significa que el servicio externo está accesible y respondiendo. Los errores relacionados con la disponibilidad del servicio o con fallos de conexión siempre generan una excepción del programa, independientemente de esta propiedad; en esos casos no hay ningún código de estado HTTP disponible.
Si ThrowExceptionOnFailed es true y la respuesta devuelve un código de error, la transacción se interrumpe y el mensaje de error aparece en Skill Monitor.
El valor de Timeout no puede superar el límite de tiempo de ejecución del script (600 segundos).

​
Métodos

​
SetHeader

void SetHeader(string name, string value);
Establece un encabezado HTTP adicional para la solicitud. Debe llamarse una vez por encabezado.

​
Send

void Send();
Envía la solicitud HTTP.

​
SetFileContent

void SetFileContent(DocumentExportResult documentExportResult, string mediaType?);
void SetFileContent(BinaryFile binaryFile, string mediaType?);
Inicializa un cuerpo de solicitud HTTP basado en un archivo. El tipo de contenido se detecta a partir de la extensión del archivo (por ejemplo, application/json, application/pdf). Para anularlo, pase mediaType.
  • La primera sobrecarga envía los datos exportados (desde Document.Exports) como un archivo.
  • La segunda sobrecarga envía datos binarios: ya sea una imagen de origen de cuando se creó la transacción o una imagen de un campo de tipo Picture.

​
SetSourceFileContent

void SetSourceFileContent(string mediaType?);
Inicializa una solicitud de datos binarios con la imagen de origen importada al crear la transacción. El tipo de contenido se detecta a partir de la extensión del archivo. Use mediaType para reemplazarlo si es necesario.
SetSourceFileContent está obsoleto; solo accede al primer archivo de una transacción. Use SetFileContent en su lugar.

​
SetStringContent

void SetStringContent(string content, ContentEncoding contentEncoding?, string mediaType?);
Inicializa un cuerpo de solicitud HTTP basado en una cadena. De forma predeterminada, usa Content-Type: application/json y la codificación UTF-8. Puede sustituir cualquiera de ellos mediante los parámetros opcionales.

​
SetUrlFormEncodedContent

void SetUrlFormEncodedContent(any content);
Inicializa el cuerpo de la solicitud a partir de un objeto de JavaScript y lo codifica como application/x-www-form-urlencoded. El objeto debe ser un conjunto simple de pares de propiedad/valor: 
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

Objeto global para datos de transacción, solicitudes HTTP y secretos.

MultipartFormDataRequest

Realice solicitudes HTTP multipart/form-data desde scripts de actividad personalizada.

BinaryFile

Datos de archivo en formato binario; normalmente, la imagen de origen antes del preprocesamiento.

DocumentExportResult

Acceda a archivos de documentos exportados (JSON, PDF, imágenes) desde un script.

ContentEncoding

Tipos de codificación disponibles para solicitudes HTTP basadas en string.

Modelo de objetos

Referencia completa del modelo de objetos de JavaScript para scripts de actividad personalizada.