File System

File System

Connect to File Systems on your local or network machines to read from and write to files using the On-Premises Data Gateway.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Creating a connection

To connect your account, you will need the following information:

Root folder
string
Root folder path (examples: \\MACHINE\myShare or C:\myShare)
Authentication Type
string
Authentication type to connect to your gateway computer
Username
securestring
Username credential (e.g. DOMAIN\Username)
Password
securestring
Password credential
Gateway
gatewaySetting

Actions

Append file

This operation appends data to a file.

Required Parameters

File
string
Select a file
File content
binary
Content to add to the file

Returns

Copy file

This operation copies a file to a file system.

Required Parameters

Source url
string
Url to source file
Destination file path
string
Destination file path, including target filename

Optional Parameters

Overwrite?
boolean
Overwrites the destination file if set to 'true

Returns

Create file

This operation creates a file. If the file already exists, the existing content is replaced.

Required Parameters

Folder path
string
Select a folder
File name
string
Name of the file
File content
binary
Content of the file

Returns

Delete file

This operation deletes a file.

Required Parameters

File
string
Select a file

Returns

Extract archive to folder

This operation extracts an archive file into a folder (example: .zip).

Required Parameters

Source archive file path
string
Path to the archive file
Destination folder path
string
Path to the destination folder

Optional Parameters

Overwrite?
boolean
Overwrites the destination files if set to 'true

Returns

array of BlobMetadata

Get file content

This operation gets the content of a file.

Required Parameters

File
string
Select a file

Optional Parameters

Infer content type
boolean
Infer content-type based on extension

Returns

File content
binary

Get file content using path

This operation gets the content of a file using the path.

Required Parameters

File path
string
Select a file

Optional Parameters

Infer content type
boolean
Infer content-type based on extension

Returns

File content
binary

Get file metadata

This operation gets the metadata for a file.

Required Parameters

File
string
Select a file

Returns

Get file metadata using path

This operation gets the metadata of a file using the path.

Required Parameters

File path
string
Select a file

Returns

List files in folder

This operation gets the list of files and subfolders in a folder.

Required Parameters

Folder
string
Select a folder

Returns

array of BlobMetadata

List files in root folder

This operation gets the list of files and subfolders in the root folder.

Required Parameters

File
string
Select a file
File content
binary
Content to add to the file

Returns

array of BlobMetadata

Update file

This operation updates a file.

Required Parameters

File
string
Select a file
File content
binary
Content of the file

Returns

Triggers

When a file is added or modified (properties only)

This operation triggers a flow when one or more files are added or modified in a folder.

Required Parameters

Folder
string
Select a folder

Optional Parameters

Maximum number of files to return from the trigger.
integer
Max file count (1-100)

Returns

List of Files
BlobMetadata

When a file is created (properties only)

This operation triggers a flow when one or more files are created in a folder.

Required Parameters

Folder
string
Select a folder

Optional Parameters

Maximum number of files to return from the trigger.
integer
Max file count (1-100)

Returns

List of Files
BlobMetadata

Definitions

BlobMetadata

DisplayName
string
ETag
string
FileLocator
string
Id
string
IsFolder
boolean
LastModified
date-time
MediaType
string
Name
string
Path
string
Size
integer