Download File from Subform
Table of Contents
Overview
This API downloads a file from a file upload, image, audio, video, or signature field of a specific subform record of a Zoho Creator application.
You can get the subform record's ID by using the Get Record APIs.
Request Details
Request URL
https://<base_url>/api/v2.1/<account_owner_name>/<app_link_name>/report/<report_link_name>/<record_ID>/<subform_link_name>.<field_link_name>/<subform_record_ID>/download
Request method
GET
Header
| Key | Value | Description |
| Authorization | Zoho-oauthtoken 1000.8cb99dxxxx xxxxxxxxx9be93.9 b8xxxxxxxxxxxxxxxf | 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 | 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. |
| 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 main form record |
| subform_link_name | the link name of the target subform |
| field_link_name | the link name of the target file upload, image, audio, video, or signature field, which is present in the subform |
| subform_record_ID | the ID of the target subform record, which can be found using the Get Record API |
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.1/jason18/zylker-store/report/All_Orders/3888834000000114050/Line_Items.Product_Manual/3888834000000104037/download"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"This sample request will download the file present in the Product_Manual field of (subform) record with ID 3888834000000104037, which is present in the Line Items subform 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 "creator.zoho.com/api/v2.1/jason18/zylker-store/report/All_Orders/3888834000000114050/Line_Items.Product_Manual/3888834000000104037/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.