This endpoint is in preview and may be modified or removed at any time.
To use this endpoint, add preview=true to the request query parameters.
Creates a new TableImport.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:connectivity-table-import-write.
stringThe Resource Identifier (RID) of a Connection (also known as a source).
objectstringThe RID of the output dataset.
string (enum)Import mode governs how data is read from an external system, and written into a Foundry dataset.
SNAPSHOT: Defines a new dataset state consisting only of data from a particular import execution. APPEND: Purely additive and yields data from previous import executions in addition to newly added data.
Enum values: SNAPSHOT, APPEND
stringbooleanAllow the TableImport to succeed if the schema of imported rows does not match the existing dataset's schema. Defaults to false for new table imports.
stringThe branch name in the output dataset that will contain the imported data. Defaults to master for most enrollments.
unionThe import configuration for a specific connector type.
objectThe created TableImport
stringThe Resource Identifier (RID) of a TableImport (also known as a batch sync).
stringThe RID of the Connection (also known as a source) that the Table Import uses to import data.
stringThe RID of the output dataset.
stringThe branch name in the output dataset that will contain the imported data. Defaults to master for most enrollments.
stringstring (enum)Import mode governs how data is read from an external system, and written into a Foundry dataset.
SNAPSHOT: Defines a new dataset state consisting only of data from a particular import execution. APPEND: Purely additive and yields data from previous import executions in addition to newly added data.
Enum values: SNAPSHOT, APPEND
booleanAllow the TableImport to succeed if the schema of imported rows does not match the existing dataset's schema. Defaults to false for new table imports.
unionThe import configuration for a specific connector type.
1
2
3
4
5
curl -X POST \
-H "Content-type: application/json" \
-H "Authorization: Bearer $TOKEN" \
"https://$HOSTNAME/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/tableImports?preview=true" \
-d '{"datasetRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da","importMode":"SNAPSHOT","displayName":"My table import","allowSchemaChanges":true,"branchName":"master"}'1
2
3
4
5
6
7
8
9
{
"datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
"importMode": "SNAPSHOT",
"displayName": "My table import",
"allowSchemaChanges": true,
"connectionRid": "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b",
"branchName": "master",
"rid": "ri.magritte..extract.27bb4f2b-63b8-44b8-a579-4e2bd65ba158"
}| Error Name | ||
|---|---|---|
Create | Error Code | PERMISSION_DENIED |
| Status Code | 403 | |
| Description | Could not create the TableImport. | |
| Parameters | connectionRid | |
See Errors for a general overview of errors in the platform.