DocsMarshal /ActivityLibrary /MicrosoftGraph /OneDrive_ItemDownload

OneDrive_ItemDownload

Description

This activity allows to download a file stored in OneDrive.

Note:

For the activity to work, the reference application in the Azure Portal must have the following API permissions. This activity allows only APPLICATION type permissions (it cannot work with "DELEGATE" ones).
Required permissions:
Files: Files.Read.All, Files.ReadWrite.All
Sites: Sites.Read.All
Check this page for more information on Azure app API permissions.

Auth

AuthString InArgument<String> REQUIRED

The authorization string to authenticate in MicrosoftGraph service.

It is possible to obtain it using the activity MsGraph_Login. Look at its dedicated page for more details.

Drive

DriveId InArgument<String>

The Id of the drive on which the activity has to work on.

Item

ItemId InArgument<String>

The Id of the item.

It is possible to obtain it by the activity OneDrive_ItemGet which allow to get the id of an item given its path.

ItemPath InArgument<String>

The path of the Item (File, Folder, ecc...). It must be '' (empty string) to work on the root of the drive. To work on any other folder the path must follow this pattern: 'folder1/folder2/folder3/.../file1.txt' (it is not necessary to specify the file if the item is a folder).

Output File

File OutArgument<IFileValue>

Provide a FileValue where to put the downloaded file if you want to save it in DocsMarshal.

LocalPath InArgument<String>

Specify the local path where to save the downloaded file if you want to save it locally.

OutputFileType EIOFileType

Specify whether you want to save the downloaded file locally or in an IFileValue.

Settings

Timeout InArgument<TimeSpan>

The maximum time the activity might take to be executed. If it takes longer, an exception will be thrown.

User

UserId InArgument<String>

The id of the Microsoft Account of the owner of the Drive.

It can be found in the result fields of certain activities such as, for example, the owner of a file returned by the OneDrive_ItemGet activity.

UserName InArgument<String>

The email of the Microsoft Account of the owner of the Drive. Example: "mario.rossi@outlook.it".