REST API connection reference

Learn about the fields used to create a REST API connection with ThoughtSpot DataFlow.

Here is a list of the fields for a REST API connection in ThoughtSpot DataFlow. You need specific information to establish a seamless and secure connection.

Connection properties

Connection name

Name your connection. Mandatory field.

Example:

RESTAPIConnection

Connection type

Choose the REST API connection type. Mandatory field.

Example:

REST API

Authentication type

Specify the type of authentication that is required to connect to the REST API service. Mandatory field.

Example:

NONE

Valid Values:

NONE, BASIC, or OAuth 2.0

Default:

NONE

Other notes:

  • NONE: Credentials not required to connect to web service.

  • BASIC: Must have Username and Password for authentication.

  • OAuth 2.0: Must supply the access key/token to connect to the web service.

REST API base URL

Specify the end point URL to access REST API web-service. Mandatory field.

Response format

Specifies the response format of the file. Mandatory field.

Example:

JSON

Valid Values:

JSON, LDJSON

User

Specify the user who connects to the Rest web service. This user must have data access privileges. Mandatory field.
For BASIC authentication type only.

Example:

userid

Password

Specify the password for the User.

Mandatory field.

Example:

pswrd234%!

Notes:

For BASIC authentication type only.

Obtain access token

Select this option to use access key/token to connect to the REST API web-service Optional field.
For OAuth 2.0 authentication type only.

Access token

Specify the access token to authenticate REST API. Optional field.
For OAuth 2.0 authentication type only.

Refresh token

Specify the refresh token to authenticate REST API. Optional field.
For OAuth 2.0 authentication type only.

OAuth client ID

Specify the OAuth client ID. Mandatory field.
Displayed only when "obtain access token" check-box is selected.

Mask client secret

Specify the OAuth client secret. Mandatory field.
Displayed only when "obtain access token" check-box is selected.

OAuth authorization URL

Specify the OAuth authorization URL. Mandatory field.
Displayed only when "obtain access token" check-box is selected

OAuth accesstoken URL

Specify the OAuth accesstoken URL. Mandatory field.
Displayed only when "obtain access token" check-box is selected

Scope

Specify the number of users to access the account. Mandatory field.
Displayed only when "obtain access token" check-box is selected

Callback URL

Secured domain URL of the repo which is used to register in REST API. Mandatory field.
Displayed only when "obtain access token" check-box is selected.

REST API parameters

When adding REST API parameters, click Add, and then specify the Parameter name, Value, and if the parameter is a Header. Optional field.

Sync properties

Column delimiter

Specify the column delimiter character. Mandatory field.

Example:

1

Valid Values:

Any printable ASCII character or decimal value for ASCII character

Default:

1

Enclosing character

Specify if the text columns in the source data needs to be enclosed in quotes. Optional field.

Example:

DOUBLE

Valid Values:

SINGLE, DOUBLE

Default:

DOUBLE

Other notes:

This is required if the text data has newline character or delimiter character.

Escape character

Specify this if the text qualifier is mentioned. This should be the character which escapes the text qualifier character in the source data. Optional field.

Example:

\"

Valid Values:

Any ASCII character

Default:

\"

Null value

Specifies the string literal that indicates the null value in the extracted data. During the data load, the column value matching this string loads as null in the target. Optional field.

Example:

NULL

Valid Values:

Any string literal

Default:

NULL

Max ignored rows

Abort the transaction after encountering 'n' ignored rows. Optional field.

Example:

0

Valid Values:

Any numeric value

Default:

0

tsload options

Specifies the parameters passed with the tsload command, in addition to the commands already included by the application. The format for these parameters is:

<param_1_name> = <param_1_value>
Example:
date_time_format = %Y-%m-%d
date_format = %Y-%m-%d;time_format = %H:%M:%S
Valid Values:
null_value = NULL
max_ignored_rows = 0
Default:
max_ignored_rows = 0

Related information

Was this page helpful?
×