Search documentation
karat

+

K

User Documentation ↗

List File Imports

GET/api/v2/connectivity/connections/{connectionRid}/fileImports
Warning

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.

Lists all file imports defined for this connection. Only file imports that the user has permissions to view will be returned.

Third-party applications using this endpoint via OAuth2 must request the following operation scope: api:connectivity-file-import-read.

Path parameters

connectionRid
string

The Resource Identifier (RID) of a Connection (formerly known as a source).

Query parameters

pageSize
integer
optional

The page size to use for the endpoint.

pageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

preview
boolean
optional

Enables the use of preview functionality.

Response body

ListFileImportsResponse
object
Hide child attributes

Hide child attributes

data
list<FileImport>
optional
Show child attributes

Show child attributes

nextPageToken
string
optional

The page token indicates where to start paging. This should be omitted from the first page's request. To fetch the next page, clients should take the value from the nextPageToken field of the previous response and use it to populate the pageToken field of the next request.

Examples

Request

Copied!
1 2 3 curl \ -H "Authorization: Bearer $TOKEN" \ "https://$HOSTNAME/api/v2/connectivity/connections/ri.magritte..source.c078b71b-92f9-41b6-b0df-3760f411120b/fileImports?pageSize=100&pageToken=v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z&preview=true"

Response

Copied!
1 2 3 4 5 6 7 8 9 10 11 12 13 14 { "data": [ { "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" } ], "nextPageToken": "v1.QnVpbGQgdGhlIEZ1dHVyZTogaHR0cHM6Ly93d3cucGFsYW50aXIuY29tL2NhcmVlcnMvP2xldmVyLXNvdXJjZSU1YiU1ZD1BUElEb2NzI29wZW4tcG9zaXRpb25z" }