UiPath Integrations

The UiPath Integrations Guide

Welcome to the UiPath Integrations guide. You will find comprehensive guides and documentation to help you start working with UiPath Integrations, as well as support if you get stuck.

In order to download the solutions mentioned here please visit the official UiPath Go! Marketplace here.

*Note that only integrations built in-house at UiPath are detailed below. For a complete list of UiPath's technology partners, see here.

Download Activity Attachment

The Download Activity Attachment activity uses the Web API GET operation to download a specified attachment (AttachmentId), to a specified location (Folder), under a new or existing name (Filename).

After downloading the attachment, the activity outputs the status of the request (success/failure information) in a ResponseStatus object (MicrosoftDynamicsStatus) that you can use in subsequent activities (e.g., conditional logic).

How it works

The following steps and message sequence diagram is an example of how the activity works from design time (i.e., the activity dependencies and input/output properties) to run time.

  1. Complete the Setup steps.
  2. Add the Microsoft Dynamics Application Scope activity to your project.
  3. Add an activity or run an external process that outputs an annotation identifier (e.g., Insert Record, Upload Activity Attachment, Search Records).
  4. Add the Download Activity Attachment activity inside the Microsoft Dynamics Application Scope activity.
  5. Enter values for the Input properties.
  6. Create and enter a ResponseStatus variable for the Output property.
    • Your input property values are sent in the GET operation request.
    • The operation returns the ResponseStatus value to your output property variable.

Properties

The values for the following properties are specified when adding this activity to your project in UiPath Studio.

Common

DisplayName

The display name of the activity.

Attributes
Details

Type

String

Required

Yes

Default value

Download Activity Attachment

Allowed values

Enter a String or String variable.

Notes

N/A


Input

AttachmentId

The identifier assigned to the attachment that you want to download.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes


Folder

The complete local path to the folder that you want to download the file to.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

N/A


Filename

The new name for the downloaded file.

Attributes
Details

Type

String

Required

No

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • By default, the file is saved using the file name of the attachment. If a file with the same name exists in the Folder, the existing file is overwritten.
  • To rename the file (and avoid unwanted overwrites), use this property to enter a new file name with the type extension (e.g., DemoFile_Download.docx)

Misc

Private

If selected, the values of variables and arguments are no longer logged at Verbose level.

Attributes
Details

Type

Checkbox

Required

No

Default value

Not Selected

Allowed values

Selected or Not Selected

Notes

N/A


Output

MicrosoftDynamicsStatus

The status of the request (success/failure information).

Attributes
Details

Type

ResponseStatus

Required

No (required if you want to use the output data in subsequent activities)

Default value

Empty

Allowed values

Enter a ResponseStatus variable.

UiPath.BAF.Models.ResponseStatus

Notes

  • The ResponseStatus object includes three properties that you can use in other activities.
    • Success - Boolean - Specifies whether the API request was successful.
    • ErrorCode - String - The response error if the API request is unsuccessful (Success=False).
    • Message - String - The error message.
  • The example image below shows some of the properties that you can return.

Example

The following image shows an example of the activity dependency relationship and input/output property values.

For step-by-step instructions and examples, see the Quickstart guide.

Updated about a month ago


Download Activity Attachment


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.