activities
latest
false
- Overview
- Adobe Sign
- Alteryx
- Amazon Comprehend
- Amazon Connect
- Amazon Rekognition
- Amazon Textract
- Box
- Release notes
- About the Box activity package
- Fix XAML After Package Update
- Project compatibility
- Setup
- Technical references
- Box Scope
- Commit Session
- Create File Version Session
- Create Upload Session
- Upload Part
- Delete Old Version
- Get Versions
- Promote Version
- Upload File Version
- Copy File
- Delete File
- Download File
- Get File Comments
- Get File Info
- Get File Info Details
- Get File Lock Info
- Lock File
- Move File
- Unlock File
- Upload File
- Copy Folder
- Create Folder
- Delete Folder
- Get Folder Info
- Get Folder Items
- Rename Folder
- Search For Content
- Execute Method
- Cognitive
- DocuSign
- Release notes
- About the DocuSign activity package
- Project compatibility
- Setup
- DocuSign Scope
- Invoke DocuSign Operation
- Create Envelope
- Create Envelope And Send
- Create Envelope From Template
- Create Envelope Recipients
- Get Document
- Get Documents
- Get Envelope
- Get Form Data
- Send Envelope
- Update Envelope
- List Attachments
- List Custom Fields
- List Documents
- List Envelope Status Changes
- List Recipients
- Create Bulk Send List
- Create Bulk Send Request
- Get Bulk Send List
- Get Bulk Send Lists
- Create Template Custom Fields
- Create Template Recipients
- Get Template
- List Templates
- Google Vision
- Jira
- Release notes
- About the Jira activity package
- Project compatibility
- Setup
- Jira Scope
- Execute Method
- Add Attachment
- Delete Attachment
- Download Attachment
- Get Attachments
- Add Comment
- Delete Comment
- Get Comments
- Create Component
- Delete Component
- Get Components
- Search Dashboards
- Create Filter
- Get Filters
- Create Issue Link
- Delete Issue Link
- Get Issue Link Types
- Get Issue Links
- Add Watcher
- Assign Issue
- Clone Issue
- Create Issue
- Delete Issue
- Get Issue
- Get Watchers
- Remove Watcher
- Search Issues Using JQL
- Transition Issue
- Update Issue
- Create Project
- Delete Project
- Get Project Types
- Get Projects
- Update Project
- Get Transitions
- Create User
- Delete User
- Find Users
- Marketo
- Microsoft Dynamics
- Microsoft Dynamics Finance and Operations
- Microsoft Translator
- Microsoft Vision
- Oracle Integration Cloud
- Oracle NetSuite
- Salesforce
- Release notes
- About the Salesforce activity package
- Project compatibility
- Setup
- Quickstart
- Salesforce Application Scope
- Create Bulk API Job
- Get Bulk API Job
- Get Bulk API Job Results
- Start or Abort Bulk API Job
- Assign File
- Download File
- Upload File
- Composite Request
- Delete Record
- Get List View Records
- Get Record
- Insert Record
- Update Record
- Upsert Record
- Execute Report
- Execute SOQL
- Format Column Names
- Format Labels And Values
- Lightning REST API Request
- Search
- SAP BAPI
- ServiceNow
- Slack
- Smartsheet
- Release notes
- About the Smartsheet activity package
- Project compatibility
- Setup
- Technical references
- Quickstart: Working With Rows
- Smartsheet Application Scope
- Attach File
- Attach URL
- Delete Attachment
- Get Attachment
- List Attachments
- Add Comment
- Delete Comment
- Get Comment
- List Discussions
- Copy Folder
- Create Folder
- Delete Folder
- Get Folder
- List Folders
- Add Group Members
- Get Group
- List Groups
- Remove Group Member
- Get Report
- List Reports
- Add Rows
- Copy Rows
- Create Discussion on Row
- Delete Rows
- Get Row
- List Rows
- Move Rows
- Update Rows
- Copy Sheet
- Create Sheet
- Create Sheet From Template
- Download Sheet
- Get Sheet
- List Sheets
- Update Sheet
- Add User
- Get User
- List Users
- Remove User
- Copy Workspace
- Create Workspace
- List Workspaces
- Import Sheet From CSV / XLSX
- Invoke Smartsheet Operation
- Search Activity
- Send Via Email
- Share Object
- SuccessFactors
- Tableau
- Twilio
- Workato
- Workday
Download Attachment
Classic Integrations Activities
Last updated Sep 25, 2024
Download Attachment
UiPath.ServiceNow.Activities.DownloadAttachment
The Download Attachment activity uses the the ServiceNow Attachment - GET{sys_id} API to download a specific file (SysId) to a local folder (FolderPath).
After downloading the attachment, the activity outputs the status of the request (success/failure information) in a
ResponseStatus
object (ServiceNowStatus) that you can use in subsequent activities (e.g., conditional logic).
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.
- Complete the Setup steps.
- Add the ServiceNow Scope activity to your project.
- Add the Download Attachment activity inside the ServiceNow Scope activity.
- Enter values for the Input properties.
-
Create and enter a
ResponseStatus
variable for the Output properties.- Your input property values are sent to the Attachment - GET{sys_id} API.
-
The API returns the
ResponseStatus
value to your output property variable.
Common
- DisplayName - The display name of the activity. This field supports only
Strings
orString
variables.
Input
- FolderPath - The complete local path that you want to download the file to. Enter a
String
orString
variable. - ObjectSysId - The sys_id of the attachment that you want to download. Enter a
String
orString
variable. 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.
Misc
- Private - If selected, the values of variables and arguments are no longer logged at Verbose level.
Output
- AttachmentId - The sys_id of the attachment. Enter a
String
a variable. The variable you create for this property can be used as an input variable in subsequent activities (e.g., Get ServiceNow Record, Download Attachment, etc.). -
ServiceNowStatus - The status of the request (success/failure information). Enter a
ResponseStatus
variable (UiPath.BAF.Models.ResponseStatus). TheResponseStatus
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.
- Success -
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.