OneDrive

OneDrive

Connect to OneDrive to manage your files. You can perform various actions such as upload, update, get, and delete on files in OneDrive.

Note:

  • This is a Standard connector.

Throttling Limits

Name Calls Renewal Period
API calls per connection 100 60 seconds

Actions

Add file tag

This operation adds a tag to a file.

Required Parameters

File
string
The unique identifier of the file.
Tag
string
The name of the tag.

Returns

Body
Tags

Tags

Convert file

This operation converts a file to another format.

Required Parameters

File
string
The unique identifier of the file.

Optional Parameters

Target type
string
The target file type

Returns

File content
binary

The content of the file.

Convert file using path

This operation converts a file to another format using the path.

Required Parameters

File Path
string
The unique path of the file.

Optional Parameters

Target type
string
The target file type

Returns

File content
binary

The content of the file.

Copy file

This operation copies a file within OneDrive.

Required Parameters

File
string
The unique identifier of the file.
Destination File Path
string
The destination file path, including target filename.

Optional Parameters

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

Returns

Body
BlobMetadata

Blob metadata

Copy file using path

This operation copies a file within OneDrive by path.

Required Parameters

File Path
string
The unique path of the file.
Destination File Path
string
The destination file path, including target filename.

Optional Parameters

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

Returns

Body
BlobMetadata

Blob metadata

Create file

This operation creates a file.

Required Parameters

Folder Path
string
The unique path of the folder.
File Name
string
The name of the file.
File Content
binary
The content of the file.

Returns

Body
BlobMetadata

Blob metadata

This operation creates a share link for a file.

Required Parameters

File
string
The unique identifier of the file.
Link type
string
The type of link

Returns

This operation creates a share link for a file using the path.

Required Parameters

File Path
string
The unique path of the file.
Link type
string
The type of link

Returns

Delete file

This operation deletes a file.

Required Parameters

File
string
The unique identifier of the file.

Returns

Body
Tags

Tags

Extract archive to folder

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

Required Parameters

Source Archive File Path
string
The path to the archive file.
Destination Folder Path
string
The path to extract the archive contents.

Optional Parameters

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

Returns

array of BlobMetadata

Find files in folder

This operation finds files within a folder using search or name pattern match.

Required Parameters

Search Query
string
The search query to use
Folder
string
The unique identifier of the folder.
File Search Mode
string
The search method to use. "Search" mode searches your OneDrive using the search query (similar a normal search engine). When "Regular Expression Pattern Match" mode is selected, the search query will be treated as a regex pattern, and it will return files with names that match the query

Optional Parameters

Number of files
integer
Max file count (1-100)

Returns

array of BlobMetadata

Find files in folder by path

This operation finds files within a folder by path using search or name pattern match.

Required Parameters

Search Query
string
The search query to use
Folder Path
string
The unique path of the folder.
File Search Mode
string
The search method to use. "Search" mode searches your OneDrive using the search query (similar a normal search engine). When "Regular Expression Pattern Match" mode is selected, the search query will be treated as a regex pattern, and it will return files with names that match the query

Optional Parameters

Number of files
integer
Max file count (1-100)

Returns

array of BlobMetadata

Get file content

This operation gets the content of a file.

Required Parameters

File
string
The unique identifier of the file.

Optional Parameters

Infer Content Type
boolean
A boolean value (true, false) to infer content-type based on extension.

Returns

File content
binary

The content of the file.

Get file content using path

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

Required Parameters

File Path
string
The unique path of the file.

Optional Parameters

Infer Content Type
boolean
A boolean value (true, false) to infer content-type based on extension.

Returns

File content
binary

The content of the file.

Get file metadata

This operation gets the metadata for a file.

Required Parameters

File
string
The unique identifier of the file.

Returns

Body
BlobMetadata

Blob metadata

Get file metadata using path

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

Required Parameters

File Path
string
The unique path of the file.

Returns

Body
BlobMetadata

Blob metadata

Get file tags

This operation gets the tags of a file.

Required Parameters

File
string
The unique identifier of the file.

Returns

Body
Tags

Tags

Get file thumbnail

This operation gets the thumbnail of a file.

Required Parameters

File
string
The unique identifier of the file.
Thumbnail Size
string
The size of the thumbnail to retrieve.

Returns

Body
Thumbnail

Thumbnail response data

List files in folder

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

Required Parameters

Folder
string
The unique identifier of the folder.

Returns

Body
BlobMetadataPage

Represents a page of blob metadata.

List files in folder [DEPRECATED]

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

Required Parameters

Folder
string
The unique identifier of the folder.

Optional Parameters

Include subfolders
boolean
Include items in subfolders

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
The unique identifier of the file.
Tag
string
The name of the tag.

Returns

array of BlobMetadata

Move or rename a file

This operation moves or renames a file.

Required Parameters

File
string
The unique identifier of the file.
Destination File Path
string
The destination file path, including target filename.

Optional Parameters

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

Returns

Body
BlobMetadata

Blob metadata

Move or rename a file using path

This operation moves or renames a file using the path.

Required Parameters

File Path
string
The unique path of the file.
Destination File Path
string
The destination file path, including target filename.

Optional Parameters

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

Returns

Body
BlobMetadata

Blob metadata

Remove file tag

This operation removes a tag from a file.

Required Parameters

File
string
The unique identifier of the file.
Tag
string
The name of the tag.

Returns

Body
Tags

Tags

Update file

This operation updates a file.

Required Parameters

File
string
The unique identifier of the file.
File Content
binary
The content of the file.

Returns

Body
BlobMetadata

Blob metadata

Upload file from URL

This operation uploads a file from a URL to OneDrive.

Required Parameters

Source URL
string
The url to the source file.
Destination File Path
string
The destination file path, including target filename.

Optional Parameters

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

Returns

Body
BlobMetadata

Blob metadata

Triggers

When a file is created

This operation triggers a flow when a new file is created in a folder.

Required Parameters

Folder
string
The unique identifier of the folder.

Optional Parameters

Infer Content Type
boolean
A boolean value (true, false) to infer content-type based on extension.

Returns

File content
binary

The content of the file.

When a file is created

This operation triggers a flow when a new file is created in a folder.

Required Parameters

Folder
string
The unique identifier of the folder.

Optional Parameters

Include subfolders
boolean
Include items in subfolders
Infer Content Type
boolean
A boolean value (true, false) to infer content-type based on extension.

Returns

File content
binary

The content of the file.

When a file is created (properties only)

This operation triggers a flow when a new file is created in a folder.

Required Parameters

Folder
string
The unique identifier of the folder.

Returns

List of Files
BlobMetadata

Blob metadata

When a file is created (properties only)

This operation triggers a flow when a new file is created in a folder.

Required Parameters

Folder
string
The unique identifier of the folder.

Optional Parameters

Include subfolders
boolean
Include items in subfolders

Returns

List of Files
BlobMetadata

Blob metadata

When a file is deleted (properties only)

This operation triggers a flow when a file is deleted from a folder.

Required Parameters

Folder
string
The unique identifier of the folder.

Optional Parameters

Include subfolders
boolean
Include items in subfolders

Returns

List of Files
BlobMetadata

Blob metadata

When a file is modified

This operation triggers a flow when a file is modified in a folder.

Required Parameters

Folder
string
The unique identifier of the folder.

Optional Parameters

Infer Content Type
boolean
A boolean value (true, false) to infer content-type based on extension.

Returns

File content
binary

The content of the file.

When a file is modified

This operation triggers a flow when a file is modified in a folder.

Required Parameters

Folder
string
The unique identifier of the folder.

Optional Parameters

Include subfolders
boolean
Include items in subfolders
Infer Content Type
boolean
A boolean value (true, false) to infer content-type based on extension.

Returns

File content
binary

The content of the file.

When a file is modified (properties only)

This operation triggers a flow when a file is modified in a folder.

Required Parameters

Folder
string
The unique identifier of the folder.

Returns

List of Files
BlobMetadata

Blob metadata

When a file is modified (properties only)

This operation triggers a flow when a file is modified in a folder.

Required Parameters

Folder
string
The unique identifier of the folder.

Optional Parameters

Include subfolders
boolean
Include items in subfolders

Returns

List of Files
BlobMetadata

Blob metadata

Definitions

BlobMetadata

Blob metadata

Display name
string
The display name of the file or folder.
ETag
string
The etag of the file or folder.
File locator
string
The file locator of the file or folder.
Id
string
The unique identifier of the file or folder.
Is folder?
boolean
A boolean value (true, false) to indicate whether or not the blob is a folder.
Last modified by
string
The user who last modified the file or folder.
Last modified time
date-time
The date and time the file or folder was last modified.
Media type
string
The media type of the file or folder.
Name
string
The name of the file or folder.
Path
string
The path of the file or folder.
Size
integer
The file or folder size in bytes.
Web URL
string
A URL that points to the file or folder.

Tags

Tags

Tags
array of string
A list of tags.

Thumbnail

Thumbnail response data

Height
integer
The thumbnail height in pixels.
Url
string
A URL that points to the thumbnail.
Width
integer
The thumbnail width in pixels.

BlobMetadataPage

Represents a page of blob metadata.

nextLink
string
A URL which can be used to retrieve the next page.
value
array of BlobMetadata
Blob metadata collection.