Download File
Table of Contents
Overview
This API downloads a file from a file upload, image, audio, video, or signature field of a specific record, which is present in a Zoho Creator application.
OpenAPI Specification
The OpenAPI Specification(OAS) is the most widely used standard for API description and refers to a standard interface for describing REST APIs. Download the OAS for the Download File API below:
Request Details
Request URL
https://<base_url>/api/v2/<account_owner_name>/<app_link_name>/report/<report_link_name>/<record_ID>/<field_link_name>/download
Request method
GET
Header
| Key | Value | Description |
| Authorization | Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf | An authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time. |
| environment | development/stage | Refers to the environment stage. |
OAuth scope
scope=ZohoCreator.report.READ
where,
| base_url | Zoho Creator: The base URL of your Creator account For example, it's creator.zoho.com if your account belongs to Zoho's US DC, and is creator.zoho.eu if it belongs to Zoho's EU DC. Zoho Creator On-premise: The base URL specific to your Zoho Creator On-premise account. This URL will be either https://host_name:port_number (learn more) or the hostname of the server where Creator On-prem is running. |
| account_owner_name | the username of the Creator account's owner |
| app_link_name | the link name of the target application |
| report_link_name | the link name of the target report |
| record_ID | the ID of the record from which you want to download the file |
| field_link_name | the link name of the target file upload, image, audio, video, or signature field |
Possible Errors
Refer to this page for the list of error codes and messages.
Sample Request for Production environment (for C6 users)
Copiedcurl "https://creator.zoho.com/api/v2/jason18/zylker-store/report/Inventory_Report/3888834000000114050/Product_Manual/download"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"This sample request will download the file present in the Product_Manual field of the record with ID 3888834000000114050, which is displayed in the Inventory Report of the Zylker Store application.
Sample Request for Development/ Stage environments (for C6 users)
Copiedcurl "https://creator.zoho.com/api/v2/jason18/zylker-store/report/Inventory_Report/3888834000000114050/Product_Manual/download"
-X GET
-H 'Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf'
-H 'environment: development'
Sample Response
If the request is a success, the target file will be downloaded.