Skip to main content

Download file from record field

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

API endpoint

GET BaseURL/Attachment/<Entity>/{recordId}/{fieldName}

  • Depending on the cloud platform you are using, use the associated Base URL.

Request headers

HeaderValue
AuthorizationBearer <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 variableData typeDescriptionDefault value
recordId (required)stringThe ID of the Data Fabric / Data Service entity's record you want to download the file from.NA
fieldName (required)stringThe 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 Fabric / 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.