REST
Establishing a Connection
Connecting to XML/JSON Data Sources
The Provider for REST allows connecting to local and remote XML/JSON resources. Set the URI property to the XML/JSON resource location, in addition to any other properties necessary to connect to your data source.
Service provider
URI formats
InitiateOAuth
OAuthClientId
OAuthClientSecret
OAuthAccessToken
OAuthAccessTokenSecret
User
Password
AuthScheme
AzureAccount
AzureAccessKey
AWSAccessKey
AWSSecretKey
AWSRegion
AccessKey
SecretKey
Region
OracleNamespace
ProjectId
Local
localPath
file://localPath/file.json
HTTP or HTTPS
http://remoteStream
https://remoteStream
OPTIONAL
OPTIONAL
OPTIONAL
Amazon S3
s3://remotePath/file.json
REQUIRED (your AccessKey)
REQUIRED (your SecretKey)
OPTIONAL
Azure Blob Storage
azureblob://mycontainer/myblob/
REQUIRED
REQUIRED (your AccessKey)
Azure Data Lake Store Gen1
adl://remotePath
adl://Account.azuredatalakestore.net@remotePath
REQUIRED
OPTIONAL
OPTIONAL
OPTIONAL
REQUIRED
REQUIRED
Azure Data Lake Store Gen2
abfs://myfilesystem/remotePath
REQUIRED
REQUIRED (your AccessKey)
Azure Data Lake Store Gen2 with SSL
abfss://myfilesystem/remotePath
REQUIRED
REQUIRED (your AccessKey)
Google Drive
gdrive://remotePath/file.json
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
REQUIRED
OneDrive
onedrive://remotePath/file.json
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
REQUIRED
Box
box://remotePath/file.json
OPTIONAL
REQUIRED
REQUIRED
OPTIONAL
OPTIONAL
REQUIRED
Dropbox
dropbox://remotePath/file.json
OPTIONAL
REQUIRED
REQUIRED
OPTIONAL
OPTIONAL
REQUIRED
SharePoint Online SOAP
sp://remotePath/file.json
REQUIRED
REQUIRED
SharePoint Online REST
sprest://remotePath/file.json
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
REQUIRED
FTP or FTPS
ftp://server:port/remotePath/file.json
ftps://server:port/remotepath/file.json
REQUIRED
REQUIRED
SFTP
sftp://server:port/remotePath/file.json
OPTIONAL
OPTIONAL
Wasabi
wasabi://bucket1/remotePath/file.json;
REQUIRED (your AccessKey)
REQUIRED (your SecretKey)
OPTIONAL
Google Cloud Storage
gs://bucket/remotePath/file.json;
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
OPTIONAL
REQUIRED
REQUIRED
Oracle Cloud Storage
os://bucket/remotePath/file.json;
REQUIRED (your AccessKey)
REQUIRED (your SecretKey)
OPTIONAL
REQUIRED
Connecting to Local Files
Set the URI to a folder containing XML/JSON files.
Below is an example connection string:
URI=C:\folder1\file.json;
Connecting to HTTP XML/JSON Streams
Set the URI to the HTTP or HTTPS URL of the XML/JSON resource you want to access as a table. Set AuthScheme to use the following authentication types. The provider also supports OAuth authentication;
HTTP:To use HTTP Basic or Digest, set the User and Password and set the corresponding AuthScheme. Set CustomHeaders if you need access to the request headers. Set CustomUrlParams to modify the URL query string.
Windows (NTLM): Set the Windows User and Password to connect and set AuthScheme to "NTLM".
Kerberos and Kerberos Delegation: To authenticate with Kerberos, set the User and Password and set AuthScheme to NEGOTIATE. To use Kerberos Delegation, set AuthScheme to KERBEROSDELEGATION.
For example:
URI=http://www.host1.com/streamname1;AuthScheme=BASIC;User=admin;Password=admin
Connecting to Amazon S3
Set the URI to an XML/JSON document in a bucket. Additionally, set the following properties to authenticate:
AWSAccessKey: Set this to an Amazon Web Services Access Key (a username).
AWSSecretKey: Set this to an Amazon Web Services Secret Key.
For example:
URI=s3://bucket1/folder1/file.json; AWSAccessKey=token1; AWSSecretKey=secret1; AWSRegion=OHIO;
Optionally, specify AWSRegion in addition.
Note: It is also possible to connect to S3-compatible services by specifying its base Url. For example, if the Url conn prp is set to http://s3.%region%.myservice.com and Region is region-1, then we will generate request URLs like https://s3.region-1.myservice.com/bucket/... (or like https://bucket.s3.region-1.myservice.com/..., if the UseVirtualHosting property is true).
Connecting to Oracle Cloud Object Storage
Set the URI to an XML/JSON document in a bucket. Additionally, set the following properties to authenticate:
AccessKey: Set this to an Oracle cloud Access Key.
SecretKey: Set this to an Oracle cloud Secret Key.
OracleNamespace: Set this to an Oracle cloud namespace.
For example:
URI=os://bucket/remotePath/; AccessKey=token1; SecretKey=secret1; OracleNamespace=myNamespace; Region=us-ashburn-1;
Optionally, specify Region in addition.
Connecting to Wasabi
Set the URI to an XML/JSON document in a bucket. Additionally, set the following properties to authenticate:
AWSAccessKey: Set this to a Wasabi Access Key (a username)
AWSSecretKey: Set this to a Wasabi Secret Key.
Optionally, specify AWSRegion in addition.
For example:
URI=wasabi://bucket1/folder1/file.json; AWSAccessKey=token1; AWSSecretKey=secret1; AWSRegion=OHIO;
Connect to Azure Blob Storage
Set the URI to the name of your container and the name of the blob. Additionally, set the following properties to authenticate:
AzureAccount: Set this to the account associated with the Azure blob.
AzureAccessKey: Set this to the access key associated with the Azure blob.
For example:
URI=azureblob://mycontainer/myblob/; AzureAccount=myAccount; AzureAccessKey=myKey;
Connect to Azure Data Lake Store Gen 2
Set the URI to the name of the file system, the name of the folder which contacts your REST files, and the name of an XML/JSON file. Additionally, set the following properties to authenticate:
AzureAccount: Set this to the account associated with the Azure data lake store.
AzureAccessKey: Set this to the access key associated with the Azure data lake store.
For example:
URI=abfs://myfilesystem/folder1/file.json; AzureAccount=myAccount; AzureAccessKey=myKey;URI=abfss://myfilesystem/folder1/file.json; AzureAccount=myAccount; AzureAccessKey=myKey;
Connecting to Box
Set the URI to the path to a XML/JSON file. To authenticate to Box, use the OAuth authentication standard. See Connecting to Box (Collaboration section) for an authentication guide.
For example:
URI=box://folder1/file.json; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;
Connecting to Dropbox
Set the URI to the path to a XML/JSON file. To authenticate to Dropbox, use the OAuth authentication standard. See Connecting to Dropbox for an authentication guide. You can authenticate with a user account or a service account. In the user account flow, you do not need to set any connection properties for your user credentials, as shown in the connection string below:
URI=dropbox://folder1/file.json; InitiateOAuth=GETANDREFRESH; OAuthClientId=oauthclientid1; OAuthClientSecret=oauthcliensecret1; CallbackUrl=http://localhost:12345;
Connecting to SharePoint Online SOAP
Set the URI to a document library containing XML/JSON files. To authenticate, set User and Password and SharepointUrl.
For example:
URI=sp://Documents/folder1; User=user1; Password=password1; SharepointUrl=https://subdomain.sharepoint.com;
Connecting to SharePoint Online REST
Set the URI to a document library containing XML/JSON files. SharepointUrl is optional. If not provided, the driver will work with the root drive. To authenticate, use the OAuth authentication standard.
For example:
URI=sp://Documents/folder1; InitiateOAuth=GETANDREFRESH; SharepointUrl=https://subdomain.sharepoint.com;
Connecting to FTP
Set the URI to the address of the server followed by the path to the XML/JSON file. To authenticate, set User and Password.
For example:
URI=ftps://localhost:990/folder1/file.json; User=user1; Password=password1;
Connecting to Google Cloud Storage
Set the URI to the path to the name of the file system, the name of the folder which contains your REST files, and the name of an XML/JSON file. To authenticate to Google APIs, provide a ProjectId.
For example:
URI=gs://bucket/remotePath/; ProjectId=PROJECT_ID;
Securing REST Connections
By default, the provider attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store. To specify another certificate, see the SSLServerCert property for the available formats to do so.
Last updated