Get Document Pages

GetPages method allows to create an image representation of each page of the document.
The following table contains method parameters description

ParameterTypeDescription
filePathstringDocument path in storage. Required.
formatstringPreview format: “PNG” (default), “JPEG”, or “BMP
heightintegerPreview image height
pageNumbersToConvertarray [integer]The list of page numbers to convert
passwordstringSource document opening password
renderCommentsbooleanRender comments (false by default)
widthintegerPreview image width
withoutAnnotationsbooleanIf true returns specific pages without annotations

API Usage

There are steps that usage of GroupDocs.Annotation Cloud consists of:

  1. Upload input document into cloud storage and other files, like image annotation
  2. Add annotation
  3. Call Preview method
  4. Download result pages from cloud storage
  5. Delete pages in cloud storage
HTTP GET ~/annotation/pages

Swagger UI lets you call this REST API directly from the browser.

cURL REST Example

// First get JSON Web Token
// Please get your App Key and App SID from https://dashboard.groupdocs.cloud/#/apps. Kindly place App Key in "client_secret" and App SID in "client_id" argument.
curl -v "https://api.groupdocs.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 example to get document information
curl -v "https://api.groupdocs.cloud/v2.0/annotation/pages?filePath=annotationdocs%2Fone-page.docx" \
-X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"
{
  "totalCount": 1,
  "entries": [
    {
      "number": 0,
      "link": {
        "href": "https://api-qa.groupdocs.cloud/v2.0/annotation/storage/file/one-page_docx/page_0.png",
        "rel": "self",
        "type": "file",
        "title": "page_0.png"
      }
    }
  ]
}

SDKs

The API is completely independent of your operating system, database system or development language. We provide and support API SDKs in many development languages in order to make it even easier to integrate. You can see our available SDKs list here.

SDK Examples


// For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-dotnet-samples
string MyAppKey = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
string MyAppSid = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
var configuration = new Configuration(MyAppSid, MyAppKey);
  
var apiInstance = new AnnotateApi(configuration);

var request = new GetPagesRequest("one-page.docx");

var response = apiInstance.GetPages(request);
Console.WriteLine("GetPages: pages count = " + response.TotalCount);


// For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-java-samples
String MyAppKey = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
String MyAppSid = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
Configuration configuration = new Configuration(MyAppSid, MyAppKey);
  
AnnotateApi apiInstance = new AnnotateApi(configuration);

// Create request object.
GetPagesRequest request = new GetPagesRequest();
request.setfilePath("Annotationdocs\\one-page.docx");

// Executing api method.
PageImages response = apiInstance.getPages(request);

System.out.println("GetPages: pages count = " + response.getTotalCount());


// For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-php-samples
use GroupDocs\Annotation\Model;
use GroupDocs\Annotation\Model\Requests;

$AppSid = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$AppKey = ""; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
$configuration = new GroupDocs\Annotation\Configuration();
$configuration->setAppSid($AppSid);
$configuration->setAppKey($AppKey);

$apiInstance = new GroupDocs\Annotation\AnnotateApi($configuration);

$request = new GroupDocs\Annotation\Model\Requests\GetPagesRequest("annotationdocs\\one-page.docx");
$response = $apiInstance->getPages($request);

echo "GetPages: pages count = ", $response->getTotalCount();


// For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-node-samples
global.annotation_cloud = require("groupdocs-annotation-cloud");

global.appSid = "XXXX-XXXX-XXXX-XXXX"; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
global.appKey = "XXXXXXXXXXXXXXXX"; // Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
global.annotateApi = annotation_cloud.AnnotateApi.fromKeys(appSid, appKey);

var request = new annotation_cloud.GetPagesRequest("Annotationdocs\\one-page.docx");
let response = await previewApi.getPages(request)
console.log("GetPages: pages count = " + response.totalCount);


# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-python-samples
import groupdocs_annotation_cloud

app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
api = groupdocs_annotation_cloud.AnnotateApi.from_keys(app_sid, app_key)

request = GetPagesRequest("annotationdocs\\one-page.docx", None, None, None, None, None, None, None)
response = api.get_pages(request)

print("GetPages: pages count = " + str(response.total_count))

# For complete examples and data files, please go to https://github.com/groupdocs-annotation-cloud/groupdocs-annotation-cloud-ruby-samples
require 'groupdocs_annotation_cloud'

$app_sid = "XXXX-XXXX-XXXX-XXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
$app_key = "XXXXXXXXXXXXXXXX" # Get AppKey and AppSID from https://dashboard.groupdocs.cloud
  
$api = GroupDocsAnnotationCloud::AnnotateApi.from_keys($app_sid, $app_key)

$request = GroupDocsAnnotationCloud::GetPagesRequest.new("Annotationdocs\\one-page.docx", nil, nil, nil, nil, nil, nil, "")

# Executing an API.
$response = $api.get_pages($request)

puts("GetPages: pages count = " + ($response.total_count).to_s)