retrieveFile
Download a file by ID
Download a file by ID
/app/retrieveFile
Usage and SDK Samples
curl -X POST\
-H "X-Drive-Token: [[apiKey]]"\
-H "Accept: text/plain"\
-H "Content-Type: application/json"\
"//app/retrieveFile"
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.FileOperationsApi;
import java.io.File;
import java.util.*;
public class FileOperationsApiExample {
public static void main(String[] args) {
ApiClient defaultClient = Configuration.getDefaultApiClient();
// Configure API key authorization: ApiKeyAuth
ApiKeyAuth ApiKeyAuth = (ApiKeyAuth) defaultClient.getAuthentication("ApiKeyAuth");
ApiKeyAuth.setApiKey("YOUR API KEY");
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.setApiKeyPrefix("Token");
FileOperationsApi apiInstance = new FileOperationsApi();
RetrieveFile_POST body = ; // RetrieveFile_POST | Download a cleaned file which has previously been uploaded to the server.
try {
apiInstance.retrieveFile(body);
} catch (ApiException e) {
System.err.println("Exception when calling FileOperationsApi#retrieveFile");
e.printStackTrace();
}
}
}
import io.swagger.client.api.FileOperationsApi;
public class FileOperationsApiExample {
public static void main(String[] args) {
FileOperationsApi apiInstance = new FileOperationsApi();
RetrieveFile_POST body = ; // RetrieveFile_POST | Download a cleaned file which has previously been uploaded to the server.
try {
apiInstance.retrieveFile(body);
} catch (ApiException e) {
System.err.println("Exception when calling FileOperationsApi#retrieveFile");
e.printStackTrace();
}
}
}
Configuration *apiConfig = [Configuration sharedConfig];
// Configure API key authorization: (authentication scheme: ApiKeyAuth)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"X-Drive-Token"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"X-Drive-Token"];
RetrieveFile_POST *body = ; // Download a cleaned file which has previously been uploaded to the server.
FileOperationsApi *apiInstance = [[FileOperationsApi alloc] init];
// Download a file by ID
[apiInstance retrieveFileWith:body
completionHandler: ^(NSError* error) {
if (error) {
NSLog(@"Error: %@", error);
}
}];
var CyberSiftDriveApi = require('cyber_sift_drive_api');
var defaultClient = CyberSiftDriveApi.ApiClient.instance;
// Configure API key authorization: ApiKeyAuth
var ApiKeyAuth = defaultClient.authentications['ApiKeyAuth'];
ApiKeyAuth.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//ApiKeyAuth.apiKeyPrefix['X-Drive-Token'] = "Token"
var api = new CyberSiftDriveApi.FileOperationsApi()
var body = ; // {{RetrieveFile_POST}} Download a cleaned file which has previously been uploaded to the server.
var callback = function(error, data, response) {
if (error) {
console.error(error);
} else {
console.log('API called successfully.');
}
};
api.retrieveFile(body, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;
namespace Example
{
public class retrieveFileExample
{
public void main()
{
// Configure API key authorization: ApiKeyAuth
Configuration.Default.ApiKey.Add("X-Drive-Token", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Configuration.Default.ApiKeyPrefix.Add("X-Drive-Token", "Bearer");
var apiInstance = new FileOperationsApi();
var body = new RetrieveFile_POST(); // RetrieveFile_POST | Download a cleaned file which has previously been uploaded to the server.
try
{
// Download a file by ID
apiInstance.retrieveFile(body);
}
catch (Exception e)
{
Debug.Print("Exception when calling FileOperationsApi.retrieveFile: " + e.Message );
}
}
}
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');
// Configure API key authorization: ApiKeyAuth
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('X-Drive-Token', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('X-Drive-Token', 'Bearer');
$api_instance = new Swagger\Client\ApiFileOperationsApi();
$body = ; // RetrieveFile_POST | Download a cleaned file which has previously been uploaded to the server.
try {
$api_instance->retrieveFile($body);
} catch (Exception $e) {
echo 'Exception when calling FileOperationsApi->retrieveFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::FileOperationsApi;
# Configure API key authorization: ApiKeyAuth
$WWW::SwaggerClient::Configuration::api_key->{'X-Drive-Token'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'X-Drive-Token'} = "Bearer";
my $api_instance = WWW::SwaggerClient::FileOperationsApi->new();
my $body = WWW::SwaggerClient::Object::RetrieveFile_POST->new(); # RetrieveFile_POST | Download a cleaned file which has previously been uploaded to the server.
eval {
$api_instance->retrieveFile(body => $body);
};
if ($@) {
warn "Exception when calling FileOperationsApi->retrieveFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint
# Configure API key authorization: ApiKeyAuth
swagger_client.configuration.api_key['X-Drive-Token'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['X-Drive-Token'] = 'Bearer'
# create an instance of the API class
api_instance = swagger_client.FileOperationsApi()
body = # RetrieveFile_POST | Download a cleaned file which has previously been uploaded to the server.
try:
# Download a file by ID
api_instance.retrieve_file(body)
except ApiException as e:
print("Exception when calling FileOperationsApi->retrieveFile: %s\n" % e)
Parameters
Body parameters
| Name | Description |
|---|---|
| body * |
|
Responses
Status: 200 - Successful operation, returns a binary file corresponding to the supplied ID
Status: 401 - Invalid Token Supplied
string
example: NOK
Status: 500 - Invalid Request
string
example: NOK