Download Activity Attachment

UiPath.MicrosoftDynamics.Activities.DownloadActivityAttachment

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 <a href=https://docs.microsoft.com/en-us/powerapps/developer/common-data-service/webapi/retrieve-entity-using-web-api?view=dynamics-ce-odata-9 target="_blank">GET operation request.
   • The operation returns the ResponseStatus value to your output property variable.
     
     

     

     
     

Properties

Common

• DisplayName - The display name of the activity. This field supports only strings or String variables.

Input

• AttachmentId - The identifier assigned to the attachment that you want to download. This field supports only Strings or String variables. To get the AttachmentId value, use an activity or run an external process that outputs an attachment identifier (e.g., Insert Record, Upload Activity Attachment, Search Records).
• Folder - The complete local path to the folder that you want to download the file to. This field supports only Strings or String variables.
• Filename - The new name for the downloaded file. This field supports only strings or String variables.
  • 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.

Output

• ResponseStatus - The status of the request (success/failure information). Enter a ResponseStatus variable (UiPath.BAF.Models.ResponseStatus). 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.

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.