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.

Please note that each Download API call returns only one file or image, even when the Multiple upload property is enabled for File Upload or Image fields.

When downloading from these fields, an additional parameter, filepath, must be included to specify which file should be retrieved.

  • filepath – The exact file path of the file to download.

To download from a File Upload or Image field containing multiple files, use the Get Records by ID or Get Records API to obtain the filepath value from the response. Pass this filepath value in the Download File API request.

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>/creator/v2.1/data/<account_owner_name>/<app_link_name>/report/<report_link_name>/<record_ID>/<field_link_name>/download

Request method

GET

Header

KeyValueDescription
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.
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_urlthe base URL of your Creator account
For example, it's www.zohoapis.com if your account belongs to Zoho's US DC, and is www.zohoapis.eu if it belongs to Zoho's EU DC.
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 record from which you want to download the file
field_link_namethe 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)

CurlDelugeJavaJavaScriptPython
Copiedcurl "https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/Inventory_Report/3888834000000114050/Product_Manual/download"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copiedresponse = invokeurl
[
	url :"https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/Inventory_Report/3888834000000114050/Product_Manual/download"
	type :GET
	connection:"zoho-creator"
];

info response;
Copiedpackage main.java.org.example;

import okhttp3.HttpUrl;
import okhttp3.OkHttpClient;
import okhttp3.Request;
import org.json.JSONException;
import java.lang.String;

public class DownloadApi
{
    public static void main(String[] args) throws JSONException
    {
        OkHttpClient client = new OkHttpClient();

        HttpUrl.Builder urlBuilder = HttpUrl.parse("https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/Inventory_Report/3888834000000114050/Product_Manual/download").newBuilder();
        Request request = new Request.Builder()
                .url(urlBuilder.toString())
                .method("GET", null)
                .addHeader("Authorization", "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf")
                .build();
        try
        {
            String response = client.newCall(request).execute().body().string();
        }
        catch (Exception e)
        {
            System.out.println("Exception while making the API request.");
        }
    }
}
Copiedlet api_headers = {
    "Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}

try {
    let response = fetch("https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/Inventory_Report/3888834000000114050/Product_Manual/download", {
        method: "GET",
        headers: api_headers
    })
}
catch (exception) {
    console.error(exception)
}
Copiedimport requests

api_headers = {
    "Authorization": "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
try:
    response = requests.get("https://www.zohoapis.com/creator/v2.1/data/jason18/zylker-store/report/Inventory_Report/3888834000000114050/Product_Manual/download", headers=api_headers)
except:
    print("Exception while making the API request.")

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://www.zohoapis.com/creator/v2.1/data/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.