HttpRequest - ABBYY Documentation

HttpRequest envía solicitudes HTTP con contenido application/x-www-form-urlencoded, de texto o datos binarios a servicios externos.

Propiedades

Name	Tipo	Acceso	Descripción
Url	string	Lectura y escritura	La URL del recurso.
Method	string	Lectura y escritura	El tipo de solicitud (por ejemplo, `GET` o `POST`).
AuthToken	string	Lectura y escritura	Token de autenticación si el servicio externo requiere autenticación.
AuthScheme	string	Lectura y escritura	Esquema de autenticación.
ThrowExceptionOnFailed	boolean	Lectura y escritura	Si es `true` (valor predeterminado), los códigos de estado de respuesta HTTP fuera del rango 200–299 generan una excepción.
Timeout	number	Lectura y escritura	Tiempo de espera de la solicitud en minutos. El valor predeterminado es 1 minuto.
ResponseText	string	De solo lectura	El cuerpo de la respuesta en formato de texto.
ResponseType	string	De solo lectura	El tipo de contenido de la respuesta (por ejemplo, `application/json`).
Status	number	De solo lectura	El código de estado de respuesta HTTP del servicio externo.

Cuando ThrowExceptionOnFailed es true (el valor predeterminado) y la respuesta devuelve un código de error, la transacción se interrumpe y el mensaje de error aparece en Skill Monitor. Cuando ThrowExceptionOnFailed es false, las respuestas de error (4xx/5xx) no generan una excepción. 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 y, en esos casos, no hay ningún código de estado HTTP disponible.

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);

​Propiedades

​Métodos

​SetHeader

​Send

​SetFileContent

​SetSourceFileContent

​SetStringContent

​SetUrlFormEncodedContent

​Temas relacionados

Propiedades

Métodos

SetHeader

Send

SetFileContent

SetSourceFileContent

SetStringContent

SetUrlFormEncodedContent

Temas relacionados