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.

Add Attachment

The Add Attachment activity uses the the ServiceNow Attachment - POST API to upload a file (Attachment) to a specific record object (Object and ObjectSysId).

After uploading the file, the activity outputs the sys_id of the attachment (AttachmentId) and the status of the upload (success/failure information) in a ResponseStatus object (ServiceNowStatus). Both of these outputs can be used as input variables in subsequent activities (e.g., AttachmentId in Download Attachment, Delete Attachment and ServiceNowStatus in 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 ServiceNow Scope activity to your project.
  3. Add the Add Attachment activity inside the ServiceNow Scope activity.
  4. Click the Configure button inside the Add Attachment activity (this opens the Object Wizard).
  5. Select the Object that you want to add the file to and 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 to the Attachment - POST API.
    • The API returns the String (sys_id) and ResponseStatus values to your output property variables.

Configure

To enter your Add Attachment property values, click the Configure button to open the Object Wizard and select a ServiceNow object (you also have the option to enter the object as a String).

To learn more about the Object Wizard, see the Business Activity Frameworks page.

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

Add Attachment

Allowed values

Enter a String or String variable.

Notes

N/A


Input

FileName

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


Object

The type of ServiceNow object that you want to upload your file to.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Use the Object Wizard to select an object or enter a valid String or String variable.

Notes

N/A


ObjectSysId

The sys_id of the ServiceNow record that you want to upload your file to.

Attributes
Details

Type

String

Required

Yes

Default value

Empty

Allowed values

Enter a String or String variable.

Notes

  • To get the sys_id value, you can follow one of the methods shown in the ServiceNow unique record identifier (sys_id) documentation or right-click on the record in the ServiceNow UI and select the Copy sys_id option in the pop-out menu (see example below).

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 sys_id of the attachment.

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 a variable.

Notes


ServiceNowStatus

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


Add Attachment


Suggested Edits are limited on API Reference Pages

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