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.

Upload Activity Attachment

The Upload Activity Attachment activity uses the Web API POST operation to upload an attachment to an email, appointment, or template activity.

After uploading the attachment, the activity outputs the String identifier assigned to the attachment (AttachmentId) and 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 a activity identifier (e.g., Insert Record, Search Records).
  4. Add the Upload Activity Attachment activity inside the Microsoft Dynamics Application Scope activity.
  5. Enter values for the Input properties.
  6. Create and enter a String and a ResponseStatus variable for the Output properties.
    • Your input property values are sent in the Web API POST operation request.
    • The operation returns the String identifer and ResponseStatus values to your output property variables.

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

Upload Activity Attachment

Allowed values

Enter a String or String variable.

Notes

N/A


Input

Activity Id

The identifier assigned to the activity that you want to upload an attachment to.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • To get the ActivityId value, use an activity or run an external process that outputs the activity identifier(e.g., Insert Record, Search Records).
  • Only activity objects that can be associated with an attachment may be used (i.e., email, appointments, template). If the activity object does not support attachments, the following error is returned:

    • ResponseStatus
      {
      ErrorCode="0x80040203",
      Message="Attachments can be associated only with e-mail activities, e-mail templates or appointments.",
      Success=false
      }

File

The complete local path to the file that you want to upload.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

N/A


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

AttachmentId

The identifier assigned to the attachment that was uploaded.

Attributes
Details

Type

String

Required

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

Default value

Empty

Allowed values

Enter a String variable.

Notes

  • To delete an attachment, you can use the AttachmentId variable in a Delete Record activity; select the ActivityMimeAttactment object.

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


Upload 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.