Get all Form Fields from the PDF Document

Introduction

This example allows you to get all of the form fields from the PDF document using Aspose.PDF Cloud API in your applications.

API Information

API	Type	Description	Swagger Link
/pdf/{name}/fields	GET	Get all document form fields	GetFields

API Parameters

Parameter	Required	Type	Data Type	Description
name	true	Path	String	The name of the document in storage to read form fields from

cURL Example

Input File: PDF With Forms

Request

Create Authentication Header


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


curl -v "http://api.aspose.cloud/v3.0/pdf/PdfWithAcroForm.pdf/fields" \
-X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"

Response


{

   "Fields":{

      "List":[

         {

            "Name":"textField",

            "SelectedItems":null,

            "Type":"Text",

            "Rect":{

               "LLX":35.8705,

               "LLY":734.055,

               "URX":125.271,

               "URY":752.266

            },

            "Values":[

               "this is the text field"

            ],

            "Links":[

               {

                  "Href":"http://api.aspose.cloud/v2.0/pdf/PdfWithAcroForm.pdf/fields/textField",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         },

         {

            "Name":"checkboxField",

            "SelectedItems":null,

            "Type":"Boolean",

            "Rect":{

               "LLX":73.3966,

               "LLY":703.704,

               "URX":86.6414,

               "URY":718.051

            },

            "Values":[

               "1"

            ],

            "Links":[

               {

                  "Href":"http://api.aspose.cloud/v2.0/pdf/PdfWithAcroForm.pdf/fields/checkboxField",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         },

         {

            "Name":"radiobuttonField",

            "SelectedItems":[

               1

            ],

            "Type":"List",

            "Rect":{

               "LLX":36.4224,

               "LLY":633.618,

               "URX":127.478,

               "URY":689.355

            },

            "Values":[

               "0",

               "1",

               "2"

            ],

            "Links":[

               {

                  "Href":"http://api.aspose.cloud/v2.0/pdf/PdfWithAcroForm.pdf/fields/radiobuttonField",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         },

         {

            "Name":"listboxField",

            "SelectedItems":[

               1

            ],

            "Type":"List",

            "Rect":{

               "LLX":37.5261,

               "LLY":577.329,

               "URX":129.134,

               "URY":625.892

            },

            "Values":[

               "item1",

               "item2",

               "item3"

            ],

            "Links":[

               {

                  "Href":"http://api.aspose.cloud/v2.0/pdf/PdfWithAcroForm.pdf/fields/listboxField",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         },

         {

            "Name":"comboboxField",

            "SelectedItems":[

               1

            ],

            "Type":"List",

            "Rect":{

               "LLX":38.0779,

               "LLY":550.84,

               "URX":129.134,

               "URY":569.603

            },

            "Values":[

               "item1",

               "item2",

               "item3"

            ],

            "Links":[

               {

                  "Href":"http://api.aspose.cloud/v2.0/pdf/PdfWithAcroForm.pdf/fields/comboboxField",

                  "Rel":"self",

                  "Type":null,

                  "Title":null

               }

            ]

         }

      ],

      "Links":[

         {

            "Href":"http://api.aspose.cloud/v2.0/pdf/PdfWithAcroForm.pdf/fields",

            "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 Fields

	// 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-input-2.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 fields from pdf document
	FieldsResponse apiResponse = pdfApi.GetFields(fileName, storage, folder);

	if (apiResponse != null && apiResponse.Status.Equals("OK"))
	{
	foreach (Field field in apiResponse.Fields.List)
	{
	Console.WriteLine("Name: " + field.Name + "Type: " + field.Type);
	}
	Console.WriteLine("Get all Form Fields from the PDF Document, Done!");
	Console.ReadKey();
	}
	}
	catch (Exception ex)
	{
	System.Diagnostics.Debug.WriteLine("error:" + ex.Message + "\n" + ex.StackTrace);
	}

view raw Examples-DotNET-CSharp-Form-Fields-GetAllFields-1.cs hosted with ❤ by GitHub

Java

	// For complete examples and data files, please go to https://github.com/aspose-pdf/Aspose.Pdf-for-Clouds
	String fileName = "sample-field.pdf";
	String storage = "";
	String folder = "";
	Path inputFile = Utils.getPath(MovePDFToNewLocation.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 fields from pdf document
	FieldsResponse apiResponse = pdfApi.GetFields(fileName, storage, folder);

	if (apiResponse != null && apiResponse.getStatus().equals("OK"))
	{
	for (Field field : apiResponse.getFields().getList())
	{
	System.out.println("Name:" + field.getName());
	System.out.println("Value:" + field.getValues().get(0));
	}
	System.out.println("Get all Form Fields from the PDF Document, Done!");
	}
	}
	catch (Exception ex)
	{
	ex.printStackTrace();
	}

view raw Examples-JAVA-SDK-src-main-java-com-aspose-pdf-cloud-examples-formfields-GetAllFormFieldsFromPDFDocument-get-all-form-fields.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 FormField {

	public $pdfApi;

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

	public function getFields() {
	// Upload file to Aspose Cloud Storage
	$fileName = "sample-field.pdf";
	Utils::uploadFile($fileName);

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

	$formField = new FormField();
	$formField->getFields();

	?>

view raw Examples-PHP-FormFields-GetFields-.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 FormField

	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

	# Get document fields.
	def get_document_fields
	file_name = "sample-field.pdf"
	upload_file(file_name)

	response = @pdf_api.get_fields(file_name)
	end

	end

	formField = FormField.new()
	puts formField.get_document_fields

view raw Examples-Ruby-FormFields-get_document_fields-.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-field.pdf"

	try:

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

	#invoke Aspose.Pdf Cloud SDK API to get all of the form fields from the PDF document
	response = pdfApi.GetFields(name)

	if response.Status == "OK":
	fields = response.Fields.List
	for field in fields:
	print "Name" + field.Name
	print "Value" + field.Values[0]

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

view raw GetAllFormFieldsFromPDFDocument.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-input-2.pdf";
	try {
	// Upload 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 of the form fields from the PDF document
	pdfApi.GetFields(name, null, null, function(responseMessage) {
	assert.equal(responseMessage.status, 'OK');
	responseMessage.body.Fields.List.forEach(function(field) {
	console.log("Name: " + field.Name + " Type: " + field.Type);
	});
	});
	});

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

view raw Examples-Node.js-Form-Fields-GetAllFields-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 = "sample1-field.pdf";
	String storage = "";
	String folder = "";
	File input = Utils.stream2file("input","pdf", context.getResources().openRawResource(R.raw.sample_field));
	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 fields from pdf document
	FieldsResponse apiResponse = pdfApi.GetFields(fileName, storage, folder);
	if (apiResponse != null && apiResponse.getStatus().equals("OK"))
	{
	for (Field field : apiResponse.getFields().getList())
	{
	System.out.println("Name:" + field.getName());
	System.out.println("Value:" + field.getValues().get(0));
	}
	System.out.println("Get all Form Fields from the PDF Document, Done!");
	}
	}
	catch (Exception ex)
	{
	ex.printStackTrace();
	}

view raw Examples-Android-app-src-main-java-com-aspose-pdf-cloud-examples-formfields-GetAllFormFieldsFromPDFDocument-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 := "4pages.pdf"
	filePath := "data/4pages.pdf"

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

	// Upload 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 all document fields
	fieldsResponse, response, _ := client.PdfApi.GetFields(fileName, options)

	fmt.Println(response.Status)
	fmt.Println(fieldsResponse.Fields.List)

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

Get a Particular Form Field from the PDF Document