Settings for GraphQL

This topic describes how to set up an GraphQL connection for DataSync.15977

To configure a new connection:

In DataSync, create a new source connection for GraphQL.
Fill out the fields in the Connection Properties panel as well as the fields described below.
Click Save.

Connection Properties

Description

Enter a name for the source connection.

URL

This property defines at which URL the API resides.
Must represent the GraphQL endpoint maybe different from the base server address.
- Value is validated.

Authentication Mode

Related connection string options and effect on the connection string will depends on the user selection.

Possible values are:

Mode
No Auth	No authentication is necessary.
Basic	User will authenticate using username and password.
OAuth2	User will authenticate against the OAuth 2.0 flow. The following parameters are required: Callback URL Client ID Client Secret Authorization URL Access Token URL Refresh Token URL Scope
OAuthPKCE	User will authenticate against the OAuth PKCE flow. The following parameters are required: Callback URL Client ID Client Secret Authorization URL Access Token URL Refresh Token URL Scope

Username

The user that will be used to authenticate. It is only available for Basic mode.

Password

The password of the user that will be used to authenticate. It is only available for Basic mode.

Callback URL

URL we return to after authenticating.
A value will be automatically assigned.
- Some API will require this to be added to the set of known callback URLs.
- Check with your application settings or your configuration portal.

Client ID

An identifier assigned to the application after the registration process.
This value should be found with your application settings or configuration portal.

Client Secret

Authorization URL

Access Token URL

Refresh Token URL

Scope

Defines the access right the user request during connection.
Verify with you configuration portal for access right configured for you application.

Additional Connection Properties	Description
HTTP Headers	For some API, Custom HTTP headers need to be include as part of API request. Click on "Add Property" button, add Http Headers. Add a line for every customer header that needs to be included.
ExpandTablesDepth	Controls for how many levels of nested lists we want to include in the discovery. Use Case : An object definition contains a list of objects and we want the nested list to be include We don’t require the inner list object to be expanded to a table. Set this value to zero. We require that a list object be expanded to a table and the list exists in the same object definition. Set this value to 1 should this list doesn’t have any list object nested. Increase the value to match with the level of nesting in the table definition.

Additional Connection Properties

Description

HTTP Headers

For some API, Custom HTTP headers need to be include as part of API request.

ExpandTablesDepth

Controls for how many levels of nested lists we want to include in the discovery.
Use Case :
- An object definition contains a list of objects and we want the nested list to be include
- We don’t require the inner list object to be expanded to a table.
  - Set this value to zero.
  - We require that a list object be expanded to a table and the list exists in the same object definition.
    - Set this value to 1 should this list doesn’t have any list object nested.
    - Increase the value to match with the level of nesting in the table definition.