Conexión a los Servicios de datos de REST

El identificador Uniform Resource Identifier (URI) o la ruta de archivo absoluta del recurso de compatible con REST.

El esquema que se utilizó para la autenticación. Los tipos de autenticación disponibles son los siguientes:

• Sin autenticación El controlador no utiliza autenticación.
• Clave de la API El controlador utiliza una clave de la API para la autenticación.
• Token de portador El controlador utiliza un token de portador para la autenticación.
• Autenticación básica El controlador utiliza una autenticación básica con un nombre de usuario y una contraseña.
• OAuth 1.0 El controlador utiliza OAuth 1.0 para la autenticación.
• OAuth 2.0 El controlador utiliza OAuth 2.0 para la autenticación.

Especifica la clave de la API para la autenticación.

Este campo queda habilitado al seleccionar Clave de la API en el campo Tipo de autorización.

El valor de este campo se utiliza con la Clave de la API proporcionada para autenticar en el servidor.

Este campo queda habilitado al seleccionar Clave de la API en el campo Tipo de autorización.

Especifica el token de portador para autenticar en el servidor. El token puede ser una clave de acceso, como un Token web JSON (JWT) que se incluye en el encabezado de la solicitud.

Este campo queda habilitado al seleccionar Token de portador en el campo Tipo de autorización.

El nombre de usuario que se utilizará para conectarse a un origen de datos de REST.

Este campo queda habilitado al seleccionar Autorización básica en el campo Tipo de autorización.

La contraseña para el nombre de usuario para conectarse a un origen de datos de REST.

Este campo queda habilitado al seleccionar Autorización básica en el campo Tipo de autorización.

El tipo de concesión para el flujo de OAuth. Las opciones disponibles son las siguientes:

• CODE

• CLIENT

• PASSWORD

Esta propiedad se puede ajustar en una cadena de encabezados HTTP para que se anexe a los encabezados de solicitud HTTP que se crean desde otras propiedades, como Tipo de contenido, Desde, entre otros.

Los encabezados deben tener el formato "encabezado: valor" tal como se describe en las especificaciones HTTP. Cada encabezado debe estar en su propia línea.

Tenga cuidado al utilizar esta opción. Si contienen encabezados no válidos, las solicitudes HTTP podrían fallar. Esta propiedad resulta útil para realizar ajustes a fin de integrarse con APIs especializadas o no estándar.

Content-Type: text/html; charset=utf-8

Conexión: keep-alive

Propiedades ocultas necesarias solo en casos de uso específico. Normalmente, no necesita introducir información aquí. Especifique varias opciones en una lista separada por puntos y comas.

Configuración de caché

• CachePartial=True Envía solo un subconjunto de columnas a la caché (usted puede especificarlo en su consulta).
• QueryPassthrough=True Pasa la consulta especificada a la base de datos de la caché en lugar de utilizar el analizador SQL del controlador.

Integración y formato

• SupportAccessLinkedMode En el modo de vinculación de Access, suele ser una buena idea usar siempre una caché ya que la mayoría de los orígenes de datos no admiten varias consultas de Id. Sin embargo, si desea utilizar el controlador en Access pero no en el modo de vinculación, esta propiedad se debe ajustar en Falso para evitar utilizar la caché de una consulta SELECT * para la tabla.
• DefaultColumnSize Establece la longitud predeterminada de los campos de la cadena cuando el origen de datos no proporciona la longitud de la columna en los metadatos. El valor predeterminado es 2000.
• ConvertDateTimeToGMT Si se deben convertir los valores de fecha-hora a GMT (UTC), en lugar de convertirlos al horario local de la máquina.
• RecordToFile=filename Registra la transferencia de datos de socket subyacente al archivo especificado.

Propiedades de OAuth

• InitiateOAuth Ajuste esta propiedad para iniciar el proceso a fin de obtener o actualizar el token de acceso de OAuth cuando se conecta. Están disponibles las siguientes opciones:

  • OFF Indica que usted controlará el flujo de OAuth en su totalidad. Se necesitará un token OAuthAccessToken para la autenticación.

  • GETANDREFRESH Indica que todo el flujo de OAuth será manejado por el controlador. Si actualmente no existe ningún token, se lo obtendrá por medio de una solicitud del navegador. Si existe un token, se lo actualizará cuando corresponda.

  • REFRESH Indica que el controlador solo manejará la actualización del token OAuthAccessToken. El controlador nunca le pedirá una autenticación por medio del navegador. Debe ocuparse de obtener OAuthAccessToken y OAuthRefreshToken desde un principio.

• OAuthSettingsLocation La ubicación del archivo de configuración donde se guardan los valores de OAuth cuando se ajusta InitiateOAuth en verdadero. Cuando InitiateOAuth está activado, el controlador guarda los valores de OAuth en un archivo de configuración para evitar pedirle al usuario que introduzca manualmente las propiedades de conexión de OAuth. Cuando expire su sesión de OAuth, el controlador obtendrá automáticamente un nuevo token de acceso si se ajusta InitiateOAuth. Si InitiateOAuth está activado pero no se define la ubicación OAuthSettingsLocation, el controlador utiliza un archivo de configuración predeterminado, %AppData%\CData\REST Data Provider\OAuthSettings.txt en Windows. En macOS, la ubicación de este archivo es ~/Library/Application Support/CData/REST Data Provider/OAuthSettings.txt. En Linux, ~/cdata/.config.

• OAuthAcccessToken El token OAuthAccessToken se recupera del servidor OAuth como parte del proceso de autenticación. Tiene un tiempo de espera que depende del servidor y se puede volver a utilizar entre una solicitud y la siguiente. El token de acceso se utiliza en lugar de su nombre de usuario y contraseña. El token de acceso protege sus credenciales conservándolas en el servidor.

• OAuthAccessTokenSecret El secreto OAuthAccessTokenSecret se recupera del servidor OAuth como parte del proceso de autenticación. Se utiliza junto con OAuthAccessToken y se puede utilizar para varias solicitudes hasta que expira.

• OAuthRefreshToken La propiedad OAuthRefreshToken se utiliza para actualizar el token OAuthAccessToken al usar la autenticación OAuth.

Especifica el modelo de datos que se debe utilizar al analizar documentos JSON o XML y generar los metadatos.

• Documento Se devuelve una tabla que representa una fila por documento. En este modelo de datos, los documentos anidados (matrices de objetos) no se aplanan y se devuelven como acumulaciones. A menos que se especifique el valor XPath de forma explícita, el controlador identificará y usará el documento superior (matriz de objeto) que encuentre como XPath.
• FlattenedDocuments Se devuelve una sola tabla que representa una unión JOIN de los documentos disponibles en el archivo XML o JSON. En este modelo de datos, los valores XPath anidados actúan de la misma manera que una unión JOIN de SQL. Además, los valores XPath hermanos (rutas hijo que se encuentran en el mismo nivel), se tratarán como SQL CROSS JOIN. A menos que se especifique de forma explícita, el controlador identificará los valores XPath disponibles analizando el archivo XML o JSON e identificando los documentos disponibles (incluidos los documentos anidados).
• Relacional Se devuelven varias tablas, una para cada valor XPath que se especifique. En este modelo de datos, se devolverán los documentos anidados (matriz de objetos) como tablas relacionadas con claves primarias y externas. A menos que se especifique de forma explícita, el controlador identificará los valores XPath disponibles analizando el archivo XML o JSON e identificando los documentos disponibles (incluidos los documentos anidados).

Por valor predeterminado, las matrices anidadas se devuelven como cadenas de JSON o XML. Se puede usar la propiedad FlattenArrays para aplanar los elementos de matrices anidadas en columnas propias. Ajuste FlattenArrays a la cantidad de elementos que desea devolver desde las matrices anidadas.

Si ajusta FlattenArrays en -1, se aplanarán todos los elementos de las matrices anidadas.

Especifica si generar un archivo de esquema (RSD) desde el documento analizado.

• Never No se generará un archivo de esquema (RSD) jamás.
• OnUse Se generará un archivo de esquema (RSD) la primera vez que se haga referencia a una tabla, siempre y cuando todavía no exista el archivo de esquema (RSD) para la tabla.
• OnStart Se generará un archivo de esquema (RSD) en el momento de la conexión para todas las tablas que no cuenten con un archivo de esquema (RSD).

Esta propiedad se utiliza en combinación con Format, URI, XPath y Location.

El valor XPath de un elemento que se repite en el mismo nivel dentro del documento JSON/XML (se utiliza para dividir el documento en varias filas).

Es posible especificar varias rutas con una lista separada por puntos y coma. El ajuste DataModel le permite configurar la manera en que se utilizarán los valores XPath para crear tablas y datos visibles.

La cantidad de filas que se deben analizar al determinar de manera dinámica columnas para la tabla. Las columnas se determinan de forma dinámica cuando no existe un archivo de esquema (RSD) para la tabla, como al utilizar GenerateSchemaFiles. Los valores más elevados generarán una solicitud más extensa, pero serán más precisos.

Si este valor se ajusta en 0 (cero) se analizará todo el documento.

Si está usando una conexión TLS/SSL, esta propiedad se puede usar para especificar que se acepte el certificado TLS/SSL desde el servidor. Cualquier otro certificado en el cual la máquina no confié será rechazado.

Si no se especifica, se aceptará cualquier certificado de confianza de la máquina.

Utilice '*' para indicar que se acepten todos los certificados (no se recomienda por motivos de seguridad).

• -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
• C:\cert.cer
• -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
• ecadbdda5a1529c58a1e9e09828d70e4
• 34a929226ae0819f2ec14b4a3d904f801cbb150d

La longitud máxima de la columna de clave primaria.

En algunas herramientas ODBC, la longitud de la columna de clave primaria no puede ser más extensa que un valor específico. Esta propiedad hace que el Controlador ODBC ignore la longitud reportada de todas las columnas clave primarias. Resulta especialmente útil al usar el Controlador ODBC como un Origen de datos vinculado de Microsoft Access.

Si ajusta LimitKeySize en 0, la longitud de la clave regresará a la longitud original.

Esta propiedad controla si una columna se devuelve o no como SQL_LONGVARCHAR.

Algunas aplicaciones exigen que todos los datos de texto que superen una cantidad determinada de caracteres se reporten como SQL_LONGVARCHAR. Utilice esta propiedad para asignar cualquier columna con un tamaño mayor al especificado para que se reporte como SQL_LONGVARCHAR en lugar de SQL_VARCHAR.

Indica si se deben o no incluir pseudo columnas como columnas en la tabla.

Este ajuste resulta especialmente útil en Entity Framework, que no permite ajustar un valor para pseudo columnas a menos que se trate de una columna de la tabla.

Puede usar un asterisco "*" para incluir todas las tablas y todas las columnas. Por ejemplo: *=*.

Table1=Column1, Table1=Column2, Table2=Column3

Este valor especifica el tipo de autenticación que se debe usar para autenticar el proxy HTTP especificado por ProxyServer y ProxyPort.

Tenga en cuenta que el controlador utilizará los ajustes de proxy del sistema por valor predeterminado, sin que sea necesaria más configuración; si desea conectarse a otro proxy, tendrá que ajustar ProxyAutoDetect en false, además de ProxyServer y ProxyPort. Para autenticar, configure ProxyAuthScheme y ajuste ProxyUser y ProxyPassword, si es necesario.

El tipo de autenticación puede ser uno de los siguientes:

• BASIC El controlador realiza la autenticación HTTP BASIC.
• DIGEST El controlador realiza la autenticación HTTP DIGEST.
• Ninguna
• NEGOTIATE El controlador recupera un token de Kerberos o NTLM en el protocolo aplicable para la autenticación
• NTLM
• PROPRIETARY El controlador no genera un token de Kerberos o NTLM. Debe proporcionar este token en el encabezado de autorización de la solicitud de HTTP.

El tipo de SSL que se debe utilizar al conectarse al proxy ProxyServer.

• AUTO Configuración predeterminada. Si la URL es una URL HTTPS, el conector utilizará la opción TUNNEL. Si la URL es una URL HTTP, el componente utilizará la opción NEVER.
• ALWAYS La conexión siempre está habilitada para SSL.
• NEVER La conexión no está habilitada para SSL.
• TUNNEL La conexión es a través de un proxy de túnel: el servidor proxy abre una conexión al host remoto y el tráfico fluye a través del proxy hacia un lado y hacia el otro.

Una lista separada por punto y coma de hosts o IPs que estarán exentas de la conexión a través de ProxyServer.

El controlador utilizará la configuración del proxy del sistema por valor predeterminado y no será necesaria ninguna otra configuración. Si desea configurar explícitamente excepciones de proxy para esta conexión, tendrá que ajustar ProxyAutoDetect en falso y configurar ProxyServer y ProxyPort. Para autenticar, configure ProxyAuthScheme y ajuste ProxyUser y ProxyPassword, si es necesario.