Get Files
Purpose
To fetch a file using its encrypted ID.
Endpoints
Request Details
Request URL
{api-domain}/crm/{version}/files
Header
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
Scope
scope=ZohoCRM.Files.{operation_type}
Possible operation types
READ - To retrieve files from ZFS
Parameters
- idstring, mandatory
The encrypted ID of the file you received in the response while uploading files to ZFS.
Possible Errors
- INVALID_URL_PATTERNHTTP 404
Please check if the URL trying to access is a correct one
Resolution: The request URL specified is incorrect. Specify a valid request URL. Refer to request URL section above. - OAUTH_SCOPE_MISMATCHHTTP 401
Unauthorized
Resolution: Client does not have ZohoCRM.Files.READ scope. Create a new client with valid scope. Refer to scope section above. - NO_PERMISSIONHTTP 403
Permission denied to read
Resolution: The user does not have permission to read files. Contact your system administrator. - INTERNAL_ERRORHTTP 500
Internal Server Error
Resolution: Unexpected and unhandled exception in Server. Contact support team. - INVALID_REQUEST_METHODHTTP 400
The http request method type is not a valid one
Resolution: You have specified an invalid HTTP method to access the API URL. Specify a valid request method. Refer to endpoints section above. - AUTHORIZATION_FAILEDHTTP 400
User does not have sufficient privilege to read.
Resolution: The user does not have the permission to read files. Contact your system administrator.
Sample Request
Copiedcurl "https://www.zohoapis.com/crm/v2/files?id=2cceafa194dxxxxxxxx4a20ed2"
-X GET
-H "Authorization: Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
Copied//String id = "ae9c7cefa418aec1d6a5cc2d9ab35c3231aae3bfeef7d5e00a54b7563c0dd42b";
//String destinationFolder = "/Users/user_name/Desktop"
//Get instance of FileOperations Class
FileOperations fileOperations = new FileOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.add(GetFileParam.ID, id);
//Call getFile method that takes paramInstance as parameters
APIResponse < ResponseHandler > response = fileOperations.getFile(paramInstance);
Copiedimport java.io.File;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import javax.net.ssl.SSLContext;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.methods.HttpUriRequest;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.conn.ssl.NoopHostnameVerifier;
import org.apache.http.conn.ssl.SSLConnectionSocketFactory;
import org.apache.http.impl.client.CloseableHttpClient;
import org.apache.http.impl.client.HttpClientBuilder;
import org.apache.http.util.EntityUtils;
public class GetFiles
{
public static void main(String[] args)
{
try
{
HttpClientBuilder httpClientBuilder = HttpClientBuilder.create();
SSLContext sslContext = SSLContext.getDefault();
SSLConnectionSocketFactory sslConnectionSocketFactory = new SSLConnectionSocketFactory(sslContext, NoopHostnameVerifier.INSTANCE);
CloseableHttpClient httpclient = httpClientBuilder.setSSLSocketFactory(sslConnectionSocketFactory).build();
URIBuilder uriBuilder = new URIBuilder("https://www.zohoapis.com/crm/v2/files");
uriBuilder.addParameter("id", "ae9c7cefa418aec1d6a5cc2d9ab35c328539eff6b9e3f07f00230d807a5b092b");
HttpUriRequest requestObj = new HttpGet(uriBuilder.build());
requestObj.addHeader("Authorization", "Zoho-oauthtoken 1000.xxxxxxx.xxxxxxx");
HttpResponse response = httpclient.execute(requestObj);
HttpEntity responseEntity = response.getEntity();
System.out.println("HTTP Status Code : " + response.getStatusLine().getStatusCode());
if(responseEntity != null)
{
if(response.containsHeader("Content-Disposition"))
{
String contentDisposition = response.getFirstHeader("Content-Disposition").getValue();
String fileName = contentDisposition.split("=")[1];
if(fileName.contains("''"))
{
fileName = fileName.split("''")[1];
}
if(fileName.contains("\""))
{
fileName = fileName.replace("\"", "");
}
//Create a file instance with the absolute_file_path
File file = new File("/Users/username/Desktop" + File.separatorChar + fileName);
//Get InputStream from the response
InputStream is = responseEntity.getContent();
//Create an OutputStream for the destination file
OutputStream os = new FileOutputStream(file);
byte[] buffer = new byte[1024];
int bytesRead;
//read the InputStream till the end
while((bytesRead = is.read(buffer)) != -1)
{
//write data to OutputStream
os.write(buffer, 0, bytesRead);
}
//Close the InputStream
is.close();
//Flush and close the OutputStream
os.flush();
os.close();
}
else
{
Object responseObject = EntityUtils.toString(responseEntity);
String responseString = responseObject.toString();
System.out.println(responseString);
}
}
}
catch(Exception ex)
{
ex.printStackTrace();
}
}
}
Copied//Get instance of FileOperations Class
$fileOperations = new FileOperations();
//Get instance of ParameterMap Class
$paramInstance = new ParameterMap();
$paramInstance->add(GetFileParam::id(), $id);
//Call getFile method that takes paramInstance as parameters
$response = $fileOperations->getFile($paramInstance);
Copied<?php
class GetFiles{
public function execute(){
$curl_pointer = curl_init();
$curl_options = array();
$url = "https://www.zohoapis.com/crm/v2/files?";
$parameters = array();
$parameters["id"]="f46166fa14ce16c6eefea966da0bddc9edf7421c6bb22cc17";
foreach ($parameters as $key=>$value){
$url =$url.$key."=".$value."&";
}
$curl_options[CURLOPT_URL] = $url;
$curl_options[CURLOPT_RETURNTRANSFER] = true;
$curl_options[CURLOPT_HEADER] = 1;
$curl_options[CURLOPT_CUSTOMREQUEST] = "GET";
$headersArray = array();
$headersArray[] = "Authorization". ":" . "Zoho-oauthtoken " ."1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf";
$curl_options[CURLOPT_HTTPHEADER]=$headersArray;
curl_setopt_array($curl_pointer, $curl_options);
$result = curl_exec($curl_pointer);
$responseInfo = curl_getinfo($curl_pointer);
curl_close($curl_pointer);
list ($headers, $content) = explode("\r\n\r\n", $result, 2);
if(strpos($headers," 100 Continue")!==false){
list( $headers, $content) = explode( "\r\n\r\n", $content , 2);
}
$headerArray = (explode("\r\n", $headers, 50));
$headerMap = array();
foreach ($headerArray as $key) {
if (strpos($key, ":") != false) {
$firstHalf = substr($key, 0, strpos($key, ":"));
$secondHalf = substr($key, strpos($key, ":") + 1);
$headerMap[$firstHalf] = trim($secondHalf);
}
}
$response = $content;
if ($response == null && $responseInfo['http_code'] != 204) {
list ($headers, $content) = explode("\r\n\r\n", $content, 2);
$response = json_decode($content, true);
}
$contentDisp = $headerMap['Content-Disposition'];
$fileName = substr($contentDisp, strrpos($contentDisp, "'") + 1, strlen($contentDisp));
if (strpos($fileName, "=") !== false)
{
$fileName = substr($fileName, strrpos($fileName, "=") + 1, strlen($fileName));
$fileName = str_replace(array(
'\'',
'"'
), '', $fileName);
}
$filePath = "/Users/test/PHP/PHPNativeSampleCode/";
$fp = fopen($filePath . $fileName, "w"); // $filePath - absolute path where downloaded file has to be stored.
$stream = $response;
fputs($fp, $stream);
fclose($fp);
}
}
(new GetFiles())->execute();
Copied//Get instance of FileOperations Class
FileOperations fileOperations = new FileOperations();
//Get instance of ParameterMap Class
ParameterMap paramInstance = new ParameterMap();
paramInstance.Add(GetFileParam.ID, id);
//Call getFile method that takes paramInstance as parameters
APIResponse<ResponseHandler> response = fileOperations.GetFile(paramInstance);
Copiedusing System;
using System.IO;
using System.Net;
namespace Com.Zoho.Crm.API.Sample.RestAPI.Files
{
public class GetFiles
{
public static void GetFile()
{
HttpWebRequest request = (HttpWebRequest)WebRequest.Create("https://www.zohoapis.com/crm/v2/files?id=ae9c7cefa418ae5b35c328539eff6b9e3f07f00230d807a5b092b");
request.Method = "GET";
request.Headers["Authorization"] = "Zoho-oauthtoken 1000.abfeXXXXXXXXXXX2asw.XXXXXXXXXXXXXXXXXXsdc2";
request.KeepAlive = true;
HttpWebResponse response;
try
{
response = (HttpWebResponse)request.GetResponse();
}
catch (WebException e)
{
if (e.Response == null) { throw; }
response = (HttpWebResponse)e.Response;
}
HttpWebResponse responseEntity = response;
Console.WriteLine("HTTP Status Code : " + (int)response.StatusCode);
WebHeaderCollection collection = responseEntity.Headers;
string contentDisposition = collection["Content-Disposition"];
if(contentDisposition != null)
{
string fileName = contentDisposition.Split(new string[] { "=" }, StringSplitOptions.None)[1];
if (fileName.Contains("''"))
{
fileName = fileName.Split(new string[] { "''" }, StringSplitOptions.None)[1];
}
fileName = fileName.Trim('\"');
string fullFilePath = Path.Combine("/Users/abc-123/Desktop", fileName);
using (FileStream outputFileStream = new FileStream(fullFilePath, FileMode.Create))
{
responseEntity.GetResponseStream().CopyTo(outputFileStream);
}
responseEntity.Close();
}
else
{
string responsestring = new StreamReader(responseEntity.GetResponseStream()).ReadToEnd();
responseEntity.Close();
Console.WriteLine(responsestring);
}
}
}
}
Copied# Get instance of FileOperations Class
file_operations = FileOperations()
# Get instance of ParameterMap Class
param_instance = ParameterMap()
# Add the id to ParameterMap instance
param_instance.add(GetFileParam.id, id)
# Call get_file method that takes ParameterMap instance as parameter
response = file_operations.get_file(param_instance)
Copieddef get_file():
import requests
import os
url = 'https://www.zohoapis.com/crm/v2/files'
headers = {
'Authorization': 'Zoho-oauthtoken 1000.04be928e4a96XXXXXXXXXXXXX68.0b9eXXXXXXXXXXXX60396e268'
}
parameters = {
'id': '479f0f5eebf0fb982f99e3832b35d23e5c5092167fb1fafa0d4d31ac7f8fd0be'
}
response = requests.get(url=url, headers=headers, params=parameters)
if response is not None:
print("HTTP Status Code : " + str(response.status_code))
if 'Content-Disposition' in response.headers:
file_name = ''
content_disposition = response.headers['Content-Disposition']
if "'" in content_disposition:
start_index = content_disposition.rindex("'")
file_name = content_disposition[start_index + 1:]
elif '"' in content_disposition:
start_index = content_disposition.rindex('=')
file_name = content_disposition[start_index + 1:].replace('"', '')
destination_file = os.path.join('/Users/aswin-7455/Documents/SDK-workspace/latest-git-csez/python/latest/zohocrm-python-sdk', file_name)
with open(destination_file, 'wb') as f:
for chunk in response:
f.write(chunk)
else:
print(response.json())
get_file()
Copied//Get instance of FileOperations Class
let fileOperations = new FileOperations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
//Add the id to ParameterMap instance
await paramInstance.add(GetFileParam.ID, id);
//Call getFile method that takes ParameterMap instance as parameter
let response = await fileOperations.getFile(paramInstance);
Copiedasync function getFile() {
const got = require("got");
const fs = require("fs");
const path = require("path");
let url = 'https://www.zohoapis.com/crm/v2/files'
let headers = {
Authorization : "Zoho-oauthtoken 1000.8cb99dxxxxxxxxxxxxx9be93.9b8xxxxxxxxxxxxxxxf"
}
let parameters = {
id : '479f0f5eebf0fb982f99e3832b35d23e5c5092167fb1fafa0d4d31ac7f8fd0be'
}
let requestDetails = {
method : "GET",
headers : headers,
searchParams : parameters,
throwHttpErrors : false
}
let response = await got(url, requestDetails)
if(response != null) {
console.log(response.statusCode);
if(response.headers.hasOwnProperty('content-type')) {
let contentType = response.headers['content-type'].split(";")[0];
if(contentType == 'application/json') {
console.log(response.body);
}
else {
let fileName = "";
let contentDisposition = (response.headers['content-disposition']);
if(contentDisposition.includes("'")){
let startIndex = contentDisposition.lastIndexOf("'");
fileName = contentDisposition.substring(startIndex + 1);
}
else if(contentDisposition.includes("\"")){
let startIndex = contentDisposition.lastIndexOf("=");
fileName = contentDisposition.substring(startIndex + 1).replace(/"/g, "");
}
fileName = path.join("/Users/abc-123/Documents/SDK-workspace/latest-git-csez/nodejs/zohocrm-nodejs-sdk", fileName);
fs.writeFileSync(fileName, response.rawBody);
}
}
}
}
getFile()
Copied# Get instance of FileOperations Class
fo = Files::FileOperations.new
# Get instance of ParameterMap Class
pm = ParameterMap.new
# Add the id to ParameterMap instance
pm.add(Files::FileOperations::GetFileParam.id, 'f46166fa14ce1XXXXXXXXXXb109cd8f502c78ffdb9324')
# Call get_file method that takes ParameterMap instance as parameter
response = fo.get_file(pm)
Copiedclass GetFiles
def execute
parameters ={}
parameters["id"]="f46166XXXXXXa966da0bddc9edf7421c6bb22cc17"
query_string = parameters.to_a.map { |x| "#{x[0]}=#{x[1]}" }.join('&')
url= "https://www.zohoapis.com/crm/v2/files"
url += '?' + query_string if !query_string.nil? && (query_string.strip != '')
url = URI(url)
req = Net::HTTP::Get.new(url.request_uri)
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
headers={}
headers["Authorization"]="Zoho-oauthtoken 1000.50XXXXXXXXX&77e3a.44XXXXXXXXX8353"
headers&.each { |key, value| req.add_field(key, value) }
response=http.request(req)
file_name = response.to_hash["content-disposition"][0].split('=')[1]
file_name = file_name.split("''")[1] if file_name.include? "''"
file_name = file_name.gsub('"', '') if file_name.include? '"'
status_code = response.code.to_i
headers = response.each_header.to_h
print status_code
print headers
unless response.body.nil?
File.open("/Users/test/RUBY/RUBYNativeSampleCode/"+file_name, 'w') { |file| file.write(response.body) }
end
end
end
GetFiles.new.execute
Copied//Get instance of FileOperations Class
let fileOperations = new ZCRM.File.Operations();
//Get instance of ParameterMap Class
let paramInstance = new ParameterMap();
//Add the id to ParameterMap instance
await paramInstance.add(ZCRM.File.Model.GetFileParam.ID, id);
//Call getFile method that takes ParameterMap instance as parameter
let response = await fileOperations.getFile(paramInstance);
Copiedvar listener = 0;
class GetFiles{
async getFile() {
var url = "https://www.zohoapis.com/crm/v2/files"
var parameters = new Map()
var headers = new Map()
var token = {
clientId:"1000.NPY9M1V0XXXXXXXXXXXXXXXXXXXF7H",
redirectUrl:"http://127.0.0.1:5500/redirect.html",
scope:"ZohoCRM.users.ALL,ZohoCRM.bulk.read,ZohoCRM.modules.ALL,ZohoCRM.settings.ALL,Aaaserver.profile.Read,ZohoCRM.org.ALL,profile.userphoto.READ,ZohoFiles.files.ALL,ZohoCRM.bulk.ALL,ZohoCRM.settings.variable_groups.ALL"
}
var accesstoken = await new GetFiles().getToken(token)
headers.set("Authorization", "Zoho-oauthtoken " + accesstoken)
parameters.set("id", "ae9c7cefa418aec1d6a5cc2d9ab35c324304c3b0a1c0cce6b94cb8ad622149b9")
var requestMethod = "GET"
var reqBody = null
var params = "";
parameters.forEach(function(value, key) {
if (parameters.has(key)) {
if (params) {
params = params + key + '=' + value + '&';
}
else {
params = key + '=' + value + '&';
}
}
});
var apiHeaders = {};
if(headers) {
headers.forEach(function(value, key) {
apiHeaders[key] = value;
});
}
if (params.length > 0){
url = url + '?' + params.substring(0, params.length - 1);
}
var requestObj = {
uri : url,
method : requestMethod,
headers : apiHeaders,
body : JSON.stringify(reqBody),
encoding: "utf8",
allowGetBody : true,
throwHttpErrors : false
};
var result = await new GetFiles().makeAPICall(requestObj);
console.log(result.status)
console.log(result.response)
var filename;
var disposition = result.getResponseHeader('content-disposition');//No I18N
if (disposition && disposition.indexOf('attachment') !== -1) {
var filenameRegex = /filename[^;=\n]*=((['"]).*?\2|[^;\n]*)/;
var matches = filenameRegex.exec(disposition);
if (matches != null && matches[1]) {
filename = matches[1].replace(/['"]/g, '');
filename = filename.replace('UTF-8','');
}
}
let readStream = result.response;
var url = URL.createObjectURL(readStream);
var ttt = document.createElement('a');
ttt.href = url;
ttt.download = filename;
ttt.click();
}
async getToken(token) {
if(listener == 0) {
window.addEventListener("storage", function(reponse) {
if(reponse.key === "access_token" && (reponse.oldValue != reponse.newValue || reponse.oldValue == null)){
location.reload();
}
if(reponse.key === "access_token"){
sessionStorage.removeItem("__auth_process");
}
}, false);
listener = 1;
if(sessionStorage.getItem("__auth_process")) {
sessionStorage.removeItem("__auth_process");
}
}
["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
var isKeyExists = localStorage.hasOwnProperty(k);
if(isKeyExists) {
sessionStorage.setItem(k, localStorage[k]);
}
localStorage.removeItem(k);
});
var valueInStore = sessionStorage.getItem("access_token");
var tokenInit = sessionStorage.getItem("__token_init");
if(tokenInit != null && valueInStore != null && Date.now() >= parseInt(tokenInit) + 59 * 60 * 1000){ // check after 59th minute
valueInStore = null;
sessionStorage.removeItem("access_token");
}
var auth_process = sessionStorage.getItem("__auth_process");
if ((valueInStore == null && auth_process == null) || (valueInStore == 'undefined' && (auth_process == null || auth_process == "true"))) {
var accountsUrl = "https://accounts.zoho.com/oauth/v2/auth"
var clientId;
var scope;
var redirectUrl;
if(token != null) {
clientId = token.clientId;
scope = token.scope;
redirectUrl = token.redirectUrl;
}
var fullGrant = sessionStorage.getItem("full_grant");
var grantedForSession = sessionStorage.getItem("granted_for_session");
if(sessionStorage.getItem("__token_init") != null && ((fullGrant != null && "true" == full_grant) || (grantedForSession != null && "true" == grantedForSession))) {
accountsUrl += '/refresh';
}
if (clientId && scope) {
sessionStorage.setItem("__token_init", Date.now());
sessionStorage.removeItem("access_token");
sessionStorage.setItem("__auth_process", "true");
window.open(accountsUrl + "?" + "scope" + "=" + scope + "&"+ "client_id" +"=" + clientId + "&response_type=token&state=zohocrmclient&redirect_uri=" + redirectUrl);
["granted_for_session", "access_token","expires_in","expires_in_sec","location","api_domain","state","__token_init","__auth_process"].forEach(function (k) {
var isKeyExists = localStorage.hasOwnProperty(k);
if(isKeyExists){
sessionStorage.setItem(k, localStorage[k]);
}
localStorage.removeItem(k);
});
valueInStore = sessionStorage.getItem("access_token");
}
}
if(token != null && valueInStore != 'undefined'){
token.accessToken = valueInStore;
}
return token.accessToken;
}
async makeAPICall(requestDetails) {
return new Promise(function (resolve, reject) {
var body, xhr, i;
body = requestDetails.body || null;
xhr = new XMLHttpRequest();
xhr.withCredentials = true;
xhr.open(requestDetails.method, requestDetails.uri, true);
for (i in requestDetails.headers) {
xhr.setRequestHeader(i, requestDetails.headers[i]);
}
xhr.responseType = "blob";//No I18N
xhr.send(body);
xhr.onreadystatechange = function() {
if(xhr.readyState == 4) {
resolve(xhr);
}
}
})
}
}
Copiedresponse = invokeurl
[
url: "https://www.zohoapis.com/crm/v2/files?id=2cceafa194dxxxxxxxx4a20ed2"
type: GET
connection:"crm_oauth_connection"
];
info response;