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 FileImport.
Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:connectivity-file-import-write.
stringThe Resource Identifier (RID) of a Connection (formerly known as a source).
objectstringThe RID of the output dataset.
string (enum)Import mode governs how raw files are read from an external system, and written into a Foundry dataset.
SNAPSHOT: Defines a new dataset state consisting only of files from a particular import execution. APPEND: Purely additive and yields data from previous import executions in addition to newly added files. UPDATE: Replaces existing files from previous import executions based on file names.
Enum values: SNAPSHOT, APPEND, UPDATE
stringstringThe branch name in the output dataset that will contain the imported data. Defaults to master for most enrollments.
stringA subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system.
list<FileImportFilter>Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. Learn more about optimizing file imports.
objectThe created FileImport
stringThe Resource Identifier (RID) of a FileImport (formerly known as a batch sync).
stringThe RID of the Connection (formerly known as a source) that the File 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.
stringlist<FileImportFilter>Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. Learn more about optimizing file imports.
string (enum)Import mode governs how raw files are read from an external system, and written into a Foundry dataset.
SNAPSHOT: Defines a new dataset state consisting only of files from a particular import execution. APPEND: Purely additive and yields data from previous import executions in addition to newly added files. UPDATE: Replaces existing files from previous import executions based on file names.
Enum values: SNAPSHOT, APPEND, UPDATE
stringA subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system.
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/fileImports?preview=true" \
-d '{"datasetRid":"ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da","importMode":"SNAPSHOT","displayName":"My file import","branchName":"master","subfolder":"subfolder1/subfolder2"}'1
2
3
4
5
6
7
8
9
{
"datasetRid": "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da",
"importMode": "SNAPSHOT",
"displayName": "My file import",
"connectionRid": "ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b",
"branchName": "master",
"subfolder": "subfolder1/subfolder2",
"rid": "ri.magritte..extract.27bb4f2b-63b8-44b8-a579-4e2bd65ba158"
}