Download a specific Attachment from a PDF

Introduction

This example allows you to download a specific attachment from a PDF using Aspose.Pdf for Cloud API in your applications. You can use our REST API with any language: .NET, Java, PHP, Ruby, Rails, Python, jQuery and many more.

API Information

API	Type	Description	Swagger Link
/pdf/{name}/attachments/{attachmentIndex}/download	GET	Download attachment information from a PDF Document	GetDownloadDocumentAttachmentByIndex

cURL Example

Request

Get AUTH Token


-X GET


curl -v "https://api.aspose.cloud/v3.0/pdf/PdfWithEmbeddedFiles.pdf/attachments/1/download" \
-X GET \
-H "Content-Type:application/json" \
-H "Authorization: Bearer <jwt token>"

Response


{  

  "Code": 200,

  "Status": "OK"

}

SDK Source

The Aspose.PDF Cloud SDKs can be downloaded from the following page: Available SDKs

SDK Examples

Download specific attachment

	// For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Cloud
	PdfApi pdfApi = new PdfApi("API_KEY", "APP_SID");

	String name = "SampleAttachment";
	String fileName = name + ".pdf";
	int attachmentIndex = 1;
	String storage = "";
	String folder = "";

	try
	{
	// Upload source file to aspose cloud storage
	pdfApi.UploadFile(fileName, System.IO.File.ReadAllBytes(Common.GetDataDir() + fileName));

	// Invoke Aspose.PDF Cloud SDK API to download specific attachment from a pdf
	ResponseMessage apiResponse = pdfApi.GetDownloadDocumentAttachmentByIndex(fileName, attachmentIndex, storage, folder);

	if (apiResponse != null)
	{
	Console.WriteLine("Download a specific Attachment from a PDF, Done!");
	Console.ReadKey();
	}
	}
	catch (Exception ex)
	{
	System.Diagnostics.Debug.WriteLine("error:" + ex.Message + "\n" + ex.StackTrace);

	}

view raw Examples-DotNET-CSharp-Attachments-DownloadSpecificAttachment-1.cs hosted with ❤ by GitHub

Java

	// For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Cloud
	String name = "SampleAttachment";
	String fileName = name + ".pdf";
	int attachmentIndex = 1;
	String storage = "";
	String folder = "";
	Path inputFile = Utils.getPath(DownloadASpecificAttachmentExample.class, fileName);

	try
	{
	// Instantiate Aspose Words API SDK
	PdfApi pdfApi = new PdfApi(Configuration.apiKey, Configuration.appSID);
	// Upload source file to aspose cloud storage
	pdfApi.uploadFile(fileName, inputFile.toFile(),null);

	// Invoke Aspose.PDF Cloud SDK API to download specific attachment from a pdf
	ResponseMessage apiResponse = pdfApi.GetDownloadDocumentAttachmentByIndex(fileName, attachmentIndex, storage, folder);

	if (apiResponse != null)
	{
	System.out.println("Download a specific Attachment from a PDF, Done!");
	}
	}
	catch (Exception ex)
	{
	ex.printStackTrace();
	}

view raw Examples-JAVA-SDK-src-main-java-com-aspose-pdf-cloud-attachments-DownloadASpecificAttachmentExample-download-all-attachment.java hosted with ❤ by GitHub

PHP

	# For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Cloud
	<?php
	require_once realpath(__DIR__ . '/..') . '/vendor/autoload.php';
	require_once realpath(__DIR__ . '/..') . '/Utils.php';

	use Aspose\PDF\PdfApi;
	use Aspose\PDF\AsposeApp;

	class Attachment {

	public $pdfApi;

	public function __construct() {
	AsposeApp::$appSID = Utils::appSID;
	AsposeApp::$apiKey = Utils::apiKey;
	$this->pdfApi = new PdfApi();
	}

	public function getDownloadDocumentAttachmentByIndex() {
	// Upload file to Aspose Cloud Storage
	$fileName = "SampleAttachment.pdf";
	Utils::uploadFile($fileName);

	$result = $this->pdfApi->GetDownloadDocumentAttachmentByIndex($name=$fileName, $attachmentIndex=1, $storage = "", $folder = "");
	print_r ( $result );
	}
	}

	$attachment = new Attachment();
	$attachment->getDownloadDocumentAttachmentByIndex();

	?>

view raw Examples-PHP-Attachments-GetDownloadDocumentAttachmentByIndex-.php hosted with ❤ by GitHub

Ruby

	# For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Cloud
	require 'aspose_pdf_cloud'

	class Attachment

	include AsposePDFCloud
	include AsposeStorageCloud

	def initialize
	#Get App key and App SID from https://cloud.aspose.com
	AsposeApp.app_key_and_sid("APP_KEY", "APP_SID")
	@pdf_api = PdfApi.new
	end

	def upload_file(file_name)
	@storage_api = StorageApi.new
	response = @storage_api.put_create(file_name, File.open("../../../data/" << file_name,"r") { \|io\| io.read } )
	end

	# Download document attachment content by its index.
	def download_document_attachment_by_index
	file_name = "SampleAttachment.pdf"
	upload_file(file_name)

	attachment_index = 1
	response = @pdf_api.get_download_document_attachment_by_index(file_name, attachment_index)
	end

	end

	attachment = Attachment.new()
	puts attachment.download_document_attachment_by_index

view raw Examples-Ruby-Attachments-download_document_attachment_by_index-.rb hosted with ❤ by GitHub

Python

	import asposepdfcloud
	from asposepdfcloud.PdfApi import PdfApi
	from asposepdfcloud.PdfApi import ApiException

	import asposestoragecloud
	from asposestoragecloud.StorageApi import StorageApi
	from asposestoragecloud.StorageApi import ResponseMessage

	apiKey = "XXXXX" #sepcify App Key
	appSid = "XXXXX" #sepcify App SID
	apiServer = "http://api.aspose.com/v1.1"
	data_folder = "../../data/"

	#Instantiate Aspose Storage API SDK
	storage_apiClient = asposestoragecloud.ApiClient.ApiClient(apiKey, appSid, True)
	storageApi = StorageApi(storage_apiClient)
	#Instantiate Aspose Pdf API SDK
	api_client = asposepdfcloud.ApiClient.ApiClient(apiKey, appSid, True)
	pdfApi = PdfApi(api_client);

	#set input file name
	fileName = "SampleAttachment"
	name = fileName + ".pdf"
	attachmentIndex = 1
	pageNumber = 1

	try:
	#upload file to aspose cloud storage
	response = storageApi.PutCreate(name, data_folder + name)

	#invoke Aspose.Pdf Cloud SDK API to download a specific attachment from a PDF
	response = pdfApi.GetDownloadDocumentAttachmentByIndex(name, attachmentIndex)

	if response.Status == "OK":
	#download attachment from response
	outfilename = "c:/temp/" + fileName + str(attachmentIndex) + ".text"
	with open(outfilename, 'wb') as f:
	for chunk in response.InputStream:
	f.write(chunk)

	except ApiException as ex:
	print "ApiException:"
	print "Code:" + str(ex.code)
	print "Message:" + ex.message

view raw DownloadSpecificAttachmentFromPDF.py hosted with ❤ by GitHub

Node.js

	For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Cloud
	var fs = require('fs');
	var assert = require('assert');
	var PdfApi = require('asposepdfcloud');
	var StorageApi = require('asposestoragecloud');
	var configProps = require('../config/config.json');
	var data_path = '../../../Data/';

	var AppSID = configProps.app_sid;
	var AppKey = configProps.api_key;
	var outFolder = configProps.out_folder;
	var config = {'appSid':AppSID,'apiKey':AppKey , 'debug' : true};

	// Instantiate Aspose Storage API SDK
	var storageApi = new StorageApi(config);
	// Instantiate Aspose.Pdf API SDK
	var pdfApi = new PdfApi(config);

	// Set input file name
	var fileName = "SampleAttachment";
	var name = fileName + ".pdf";
	var attachmentIndex = 1;

	try {
	// Upload source file to aspose cloud storage
	storageApi.PutCreate(name, null, null, data_path + name , function(responseMessage) {

	assert.equal(responseMessage.status, 'OK');

	// Invoke Aspose.Pdf Cloud SDK API to download a specific attachment from a PDF
	pdfApi.GetDownloadDocumentAttachmentByIndex(name, attachmentIndex, null, null, function(responseMessage) {
	assert.equal(responseMessage.status, 'OK');

	// Download attachment from response
	var outfilename = fileName + attachmentIndex + ".text";
	var writeStream = fs.createWriteStream(data_path + outfilename);
	writeStream.write(responseMessage.body);
	});
	});

	}catch (e) {
	console.log("exception in example");
	console.log(e);
	}

view raw Examples-Node.js-Attachments-DownloadSpecificAttachment-1.js hosted with ❤ by GitHub

Android

	// For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.PDF-for-Cloud
	String name = "SampleAttachment";
	String fileName = name + ".pdf";
	int attachmentIndex = 1;
	String storage = "";
	String folder = "";
	File inputFile = Utils.stream2file("SampleAttachment","pdf", context.getResources().openRawResource(R.raw.SampleAttachment));
	try
	{
	StorageApi storageApi = new StorageApi(Configuration.apiKey, Configuration.appSID, true);
	// Instantiate Aspose Words API SDK
	PdfApi pdfApi = new PdfApi(Configuration.apiKey, Configuration.appSID, true);
	// Upload source file to aspose cloud storage
	storageApi.PutCreate(fileName, "", "", inputFile);
	// Invoke Aspose.PDF Cloud SDK API to download specific attachment from a pdf
	ResponseMessage apiResponse = pdfApi.GetDownloadDocumentAttachmentByIndex(fileName, attachmentIndex, storage, folder);
	if (apiResponse != null)
	{
	System.out.println("Download a specific Attachment from a PDF, Done!");
	}
	}
	catch (Exception ex)
	{
	ex.printStackTrace();
	}

view raw Examples-Android-app-src-main-java-com-aspose-pdf-cloud-examples-attachments-DownloadASpecificAttachmentExample-1.java hosted with ❤ by GitHub

	// For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Cloud
	fileName := "sample-attachments.pdf"
	filePath := "data/sample-attachments.pdf"

	attachmentIndex := int32(1)

	// init words cloud api
	config := asposepdfcloud.NewConfiguration(AppSid, AppKey, BaseURL)
	client := asposepdfcloud.NewAPIClient(config)

	// Upload 1st document
	file, _ := os.Open(filePath)
	_, _, err1 := client.PdfApi.UploadFile(fileName, file, nil)
	if err1 != nil {
	fmt.Println(err1)
	}

	options := map[string]interface{}{
	"storage": "First Storage",
	}

	//Get attachments
	attachmentResponse, response, _ := client.PdfApi.GetDownloadDocumentAttachmentByIndex(fileName, attachmentIndex, options)

	fmt.Println(response.Status)

	if attachmentResponse != nil
	fmt.Println("File Downloaded successfully!")

view raw Examples-Go-DownloadAttachment.go hosted with ❤ by GitHub

Read information for a specific Attachment in a PDF Document