Download File from Subform

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.

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 from Subform API below:

Request Details

Request URL

https://<base_url>/api/v2/<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

KeyValueDescription
AuthorizationZoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxfAn authentication token (authtoken) allows users to access apps and APIs without having to enter their login credentials each time.
environmentdevelopment/stageRefers to the environment stage.
Note: By default, production value will be considered for the environment header.

OAuth scope

scope=ZohoCreator.report.READ

where,

base_urlZoho 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_namethe username of the Creator account's owner
app_link_namethe link name of the target application
report_link_namethe link name of the target report
record_IDthe ID of the main form record
subform_link_namethe link name of the target subform
field_link_namethe link name of the target file upload, image, audio, video, or signature field, which is present in the subform
subform_record_IDthe 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/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/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.