data-service
2022.10
false
  • Data Service OpenAPI
UiPath logo, featuring letters U and I in white

Data Service API Guide

Automation CloudAutomation Cloud Public SectorAutomation Suite
Last updated Apr 19, 2024

Download File from Record Field

Downloads the file from the specified field of an existing Entity record.

API Endpoint

docs imageBaseURL/Attachment/<Entity>/{recordId}/{fieldName}
  • BaseURL:

Request Headers

Header

Value

Authorization

Bearer <access_token>
Note:
Replace all the values between the angle brackets <...> with their corresponding use-case values.
The <access_token> is the one you received when you authorized the external application. It is available for 1 hour, then you need to generate a new one, or request a refresh token.

Path Variables

Path Variable

Data Type

Description

Default Value

recordId (Required)

string

The ID of the Data Service entity's record you want to download the file from.

NA

fieldName (Required)

string

The name of the File type field where the record you want to download the file from is found. The name must correspond to a valid field, and it is case-sensitive.

NA

Responses

200 OK

401 Unauthorized

You are not authenticated to access Data Service. Make sure your Assistant or Robot is connected to a modern folder in your account.

403 Forbidden

You don't have permission to access the entity, field, or record, or you are using an unsupported robot type. Please contact your administrator for the necessary permissions.

  • API Endpoint
  • Request Headers
  • Path Variables
  • Responses
  • 200 OK
  • 401 Unauthorized
  • 403 Forbidden

Was this page helpful?

Get The Help You Need
Learning RPA - Automation Courses
UiPath Community Forum
Uipath Logo White
Trust and Security
© 2005-2024 UiPath. All rights reserved.