Get Document Information

Introduction

This REST API allows us to obtain basic information about the document and it’s pages properties. The endpoint accepts the document storage path as input payload. Here is the list of properties that can be obtained for a document:

  • Document file extension;
  • Document size in bytes;
  • Document file format.

Here is the list of properties that can be obtained for document pages:

  • Page width in pixels (when converted to the image);
  • Page height in pixels (when converted to image);
  • Page number;
  • Visible property that indicates whether the page is visible or not.

Resource URI


HTTP POST ~/info

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

cURL 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/v1.0/merger/info" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer
<jwt token>"
-d "{ FilePath: '/wordprocessing/four-pages.docx' }"

 {
  "extension": ".docx",
  "pages": [
   {
    "width": 612,
   "height": 792,
   "pageNumber": 1,
   "visible": true
   },
   {
   "width": 612,
   "height": 792,
    "pageNumber": 2,
    "visible": true
   },
   {
    "width": 612,
   "height": 792,
   "pageNumber": 3,
   "visible": true
   },
   {
   "width": 612,
    "height": 792,
   "pageNumber": 4,
   "visible": true
   }],
 "size": 8651,
 "fileFormat": "Microsoft Word Open XML Document"
}

SDKs

Using an SDK (API client) is the quickest way for a developer to speed up the development. An SDK takes care of a lot of low-level details of makingRequests and handlingResponses and lets you focus on writing code specific to your particular project. Check out our GitHub repository for a complete list of GroupDocs.Merger Cloud SDKs along with working examples, to get you started in no time. Please check the Get Document Information article to learn how to add an SDK to your project.

Get Document Information