Get all Bookmarks from a PDF

Introduction

This example allows you to get all bookmarks from a PDF using Aspose.PDF Cloud API in your applications.

API Information

API	Type	Description	Swagger Link
/pdf/{name}/bookmarks/tree	GET	Read Document Bookmarks Tree	GetDocumentBookmarks

cURL Example

Input Document: PDFWithBookmars.pdf

Request

Get Authorization Token


curl -v "https://api.aspose.cloud/connect/token" -X POST -d "grant_type=client_credentials&client_id=<APP_SID>&client_secret=<APP_KEY>" -H "Content-Type: application/x-www-form-urlencoded" -H "Accept: application/json"

Request


curl -v "https://api.aspose.cloud/v3.0/pdf/PdfWithBookmarks.pdf/bookmarks/tree" -X GET -H "Accept: application/json" -H "Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYmYiOjE1NjIwMTIyMTcsImV4cCI6MTU2MjA5ODYxNywiaXNzIjoiaHR0cHM6Ly9hcGkuYXNwb3NlLmNsb3VkIiwiYXVkIjpbImh0dHBzOi8vYXBpLmFzcG9zZS5jbG91ZC9yZXNvdXJjZXMiLCJhcGkucGxhdGZvcm0iLCJhcGkucHJvZHVjdHMiXSwiY2xpZW50X2lkIjoiNzg5NDZmYjQtM2JkNC00ZDNlLWIzMDktZjllMmZmOWFjNmY5Iiwic2NvcGUiOlsiYXBpLnBsYXRmb3JtIiwiYXBpLnByb2R1Y3RzIl19.mwj8eey4SNAbw0Ww12cyXsh5-LaHiP-nWoquh5LOYFhNYspQBZQQkjpbyQ81j2Za36ebr4Foiy7OEc0FGXpQSDEHGyeJlPj6cocNYez1s5OKnweHuoQ6LAcacYPnXPQ3FTnHgSbdfk_ewWXRmZr-GdQy-A_3Z7ZH7ZkbvnCDNLLTteKY050yj2ZbEte6pd4xS5PgwOFguTzv6VslI-U_C3n1BYAvwfv0-mqthEZiJOWXVn9jQxisjDpZO6-Zx1v4L1_Wnti1acSFupW-FHxucDeRBmExwHP-7p2CzsqoVQ2ElkzJZJ6ZCF4v8B19yHItR6wkGqk8rsIq19gRR7D3NA" --ssl-no-revoke

Response


{

   "Bookmarks":{

      "List":[

         {

            "Title":"Page 1 (XYZ)",

            "Italic":true,

            "Bold":false,

            "Color":{

               "A":255,

               "R":255,

               "G":0,

               "B":0

            },

            "Action":"GoTo",

            "Level":1,

            "Destination":"1",

            "PageDisplay":"XYZ",

            "PageDisplay_Bottom":null,

            "PageDisplay_Left":82,

            "PageDisplay_Right":null,

            "PageDisplay_Top":784,

            "PageDisplay_Zoom":2,

            "PageNumber":1,

            "RemoteFile":null,

            "Bookmarks":{

               "List":[

                  {

                     "Title":"Text",

                     "Italic":false,

                     "Bold":false,

                     "Color":null,

                     "Action":"GoTo",

                     "Level":2,

                     "Destination":"1",

                     "PageDisplay":"XYZ",

                     "PageDisplay_Bottom":null,

                     "PageDisplay_Left":17,

                     "PageDisplay_Right":null,

                     "PageDisplay_Top":831,

                     "PageDisplay_Zoom":2,

                     "PageNumber":1,

                     "RemoteFile":null,

                     "Bookmarks":null,

                     "Links":[

                        {

                           "Href":"/1",

                           "Rel":"self",

                           "Type":null,

                           "Title":null

                        }

                     ]

                  }

               ],

               "Links":[

                  {

                     "Href":"/PdfWithBookmarks.pdf/bookmarks/1/bookmarks",

                     "Rel":"self",

                     "Type":null,

                     "Title":null

                  }

               ]

            },

            "Links":[

               {

                  "Href":"/1",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         },

         {

            "Title":"Page 2 (Fit)",

            "Italic":false,

            "Bold":false,

            "Color":null,

            "Action":"GoTo",

            "Level":1,

            "Destination":"2",

            "PageDisplay":"Fit",

            "PageDisplay_Bottom":null,

            "PageDisplay_Left":null,

            "PageDisplay_Right":null,

            "PageDisplay_Top":null,

            "PageDisplay_Zoom":null,

            "PageNumber":2,

            "RemoteFile":null,

            "Bookmarks":null,

            "Links":[

               {

                  "Href":"/2",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         },

         {

            "Title":"Page 2 (FitB)",

            "Italic":false,

            "Bold":false,

            "Color":null,

            "Action":"GoTo",

            "Level":1,

            "Destination":"2",

            "PageDisplay":"FitB",

            "PageDisplay_Bottom":null,

            "PageDisplay_Left":null,

            "PageDisplay_Right":null,

            "PageDisplay_Top":null,

            "PageDisplay_Zoom":null,

            "PageNumber":2,

            "RemoteFile":null,

            "Bookmarks":null,

            "Links":[

               {

                  "Href":"/3",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         },

         {

            "Title":"Page 3 (FitV)",

            "Italic":false,

            "Bold":false,

            "Color":null,

            "Action":"GoTo",

            "Level":1,

            "Destination":"3",

            "PageDisplay":"FitV",

            "PageDisplay_Bottom":null,

            "PageDisplay_Left":82,

            "PageDisplay_Right":null,

            "PageDisplay_Top":null,

            "PageDisplay_Zoom":null,

            "PageNumber":3,

            "RemoteFile":null,

            "Bookmarks":null,

            "Links":[

               {

                  "Href":"/4",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         },

         {

            "Title":"Page 3 (FitBV)",

            "Italic":false,

            "Bold":false,

            "Color":null,

            "Action":"GoTo",

            "Level":1,

            "Destination":"3",

            "PageDisplay":"FitBV",

            "PageDisplay_Bottom":null,

            "PageDisplay_Left":82,

            "PageDisplay_Right":null,

            "PageDisplay_Top":null,

            "PageDisplay_Zoom":null,

            "PageNumber":3,

            "RemoteFile":null,

            "Bookmarks":null,

            "Links":[

               {

                  "Href":"/5",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         },

         {

            "Title":"Page 4 (FitH)",

            "Italic":false,

            "Bold":false,

            "Color":null,

            "Action":"GoTo",

            "Level":1,

            "Destination":"4",

            "PageDisplay":"FitH",

            "PageDisplay_Bottom":null,

            "PageDisplay_Left":null,

            "PageDisplay_Right":null,

            "PageDisplay_Top":784,

            "PageDisplay_Zoom":null,

            "PageNumber":4,

            "RemoteFile":null,

            "Bookmarks":null,

            "Links":[

               {

                  "Href":"/6",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         },

         {

            "Title":"Page 4 (FitBH)",

            "Italic":false,

            "Bold":false,

            "Color":null,

            "Action":"GoTo",

            "Level":1,

            "Destination":"4",

            "PageDisplay":"FitBH",

            "PageDisplay_Bottom":null,

            "PageDisplay_Left":null,

            "PageDisplay_Right":null,

            "PageDisplay_Top":784,

            "PageDisplay_Zoom":null,

            "PageNumber":4,

            "RemoteFile":null,

            "Bookmarks":null,

            "Links":[

               {

                  "Href":"/7",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         },

         {

            "Title":"Page 5 (FitR)",

            "Italic":false,

            "Bold":false,

            "Color":null,

            "Action":"GoTo",

            "Level":1,

            "Destination":"5",

            "PageDisplay":"FitR",

            "PageDisplay_Bottom":702,

            "PageDisplay_Left":82,

            "PageDisplay_Right":164,

            "PageDisplay_Top":784,

            "PageDisplay_Zoom":null,

            "PageNumber":5,

            "RemoteFile":null,

            "Bookmarks":null,

            "Links":[

               {

                  "Href":"/8",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         }

      ],

      "Links":[

         {

            "Href":"/PdfWithBookmarks.pdf/bookmarks",

            "Rel":"self",

            "Type":null,

            "Title":null

         }

      ]

   },

   "Code":200,

   "Status":"OK"

}

SDK Source

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

SDK Examples

Get all bookmarks

	// 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 fileName = "Sample-Bookmark.pdf";
	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 get all bookmarks from pdf
	BookmarksResponse apiResponse = pdfApi.GetDocumentBookmarks(fileName, storage, folder);

	if (apiResponse != null && apiResponse.Status.Equals("OK"))
	{
	Com.Aspose.PDF.Model.Bookmarks bookmarks = apiResponse.Bookmarks;
	Console.WriteLine("Get all Bookmarks from a PDF,Done!");
	Console.ReadKey();
	}
	}
	catch (Exception ex)
	{
	System.Diagnostics.Debug.WriteLine("error:" + ex.Message + "\n" + ex.StackTrace);

	}

view raw Examples-DotNET-CSharp-Bookmarks-GetAllBookmarks-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 fileName = "Sample-Bookmark.pdf";
	String storage = "";
	String folder = "";
	Path inputFile = Utils.getPath(GetAllBookmarksExample.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 get all bookmarks from pdf
	BookmarksResponse apiResponse = pdfApi.GetDocumentBookmarks(fileName, storage, folder);

	if (apiResponse != null && apiResponse.getStatus().equals("OK"))
	{
	Bookmarks bookmarks = apiResponse.getBookmarks();
	System.out.println("Get all Bookmarks from a PDF,Done!");
	}
	}
	catch (Exception ex)
	{
	ex.printStackTrace();
	}

view raw Examples-JAVA-SDK-src-main-java-com-aspose-pdf-cloud-bookmarks-GetAllBookmarksExample-get-all-bookmarks.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 Bookmark {

	public $pdfApi;

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

	public function getDocumentBookmarks() {
	// Upload file to Aspose Cloud Storage
	$fileName = "Sample-Bookmark.pdf";
	Utils::uploadFile($fileName);

	$result = $this->pdfApi->GetDocumentBookmarks($fileName, $storage = "", $folder = "");
	print_r ( $result );
	}
	}

	$bookmark = new Bookmark();
	$bookmark->getDocumentBookmarks();

	?>

view raw Examples-PHP-Bookmarks-GetDocumentBookmarks-.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 Bookmark

	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

	# Read document bookmarks.
	def read_document_bookmarks
	file_name = "Sample-Bookmark.pdf"
	upload_file(file_name)

	response = @pdf_api.get_document_bookmarks(file_name)
	end

	end

	bookmark = Bookmark.new()
	puts bookmark.read_document_bookmarks

view raw Examples-Ruby-Bookmarks-read_document_bookmarks-.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
	name = "Sample-Bookmark.pdf"

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

	#invoke Aspose.Pdf Cloud SDK API to get all bookmarks from a PDF
	response = pdfApi.GetDocumentBookmarks(name)

	if response.Status == "OK":
	bookmarks = response.Bookmarks
	for bookmark in bookmarks.List:
	print "Boorkmark Href :: " + bookmark.Links[0].Href


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

view raw GetAllBookmarksFromPDFPage.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 name = "Sample-Bookmark.pdf";
	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 get all bookmarks from a PDF
	pdfApi.GetDocumentBookmarks(name, null, null, function(responseMessage) {
	assert.equal(responseMessage.status, 'OK');
	responseMessage.body.Bookmarks.List.forEach(function(bookmark) {
	console.log("Boorkmark Href :: " + bookmark.Links[0].Href );
	});
	});
	});

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

view raw Examples-Node.js-Bookmarks-GetAllBookmarks-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 fileName = "Sample-Bookmark.pdf";
	String storage = "";
	String folder = "";
	File input = Utils.stream2file("Bookmark","pdf", context.getResources().openRawResource(R.raw.Sample_Bookmark));
	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, "", "", input);
	// Invoke Aspose.PDF Cloud SDK API to get all bookmarks from pdf
	BookmarksResponse apiResponse = pdfApi.GetDocumentBookmarks(fileName, storage, folder);
	if (apiResponse != null && apiResponse.getStatus().equals("OK"))
	{
	Bookmarks bookmarks = apiResponse.getBookmarks();
	System.out.println("Get all Bookmarks from a PDF,Done!");
	}
	}
	catch (Exception ex)
	{
	ex.printStackTrace();
	}

view raw Examples-Android-app-src-main-java-com-aspose-pdf-cloud-examples-bookmarks-GetAllBookmarksExample-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 := "PdfWithBookmarks.pdf"
	filePath := "data/PdfWithBookmarks.pdf"
	bookmarkPath := "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 bookmarks
	bookmarkResponse, response, _ := client.PdfApi.GetBookmarks(fileName, bookmarkPath, options)

	fmt.Println(response.Status)
	fmt.Println(bookmarkResponse.Bookmarks.List[0].Destination)

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

Get a Specific Bookmark from a PDF