Get Document Information

Introduction

\

This REST API allows obtaining basic information about the document. 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;
  • Document page count.

The table below contains the full list of properties.

NameDescriptionComment
FileInfo.FilePathThe path of the document, located in the storage.Required.
FileInfo.StorageNameStorage nameIt could be omitted for default storage.
FileInfo.PasswordThe password to open fileIt should be specified only for password-protected documents.
ContainerItemInfo.RelativePathThe relative path of the container.Should be specified only for container files like ZIP archives, emails or PDF portfolios.
ContainerItemInfo.PasswordPassword for processing password-protected container items.It should be specified only for password-protected container items.

Resources

The following GroupDocs.Parser Cloud REST API resource has been used in the Get Document Information example.

Resource URI


HTTP POST ~/info

cURL Example

The following example demonstrates how to get document information.

Request

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

Response

{
    "fileType": {
        "fileFormat": "Microsoft Word Open XML Document",
        "extension": ".docx"
    },
    "size": 8651,
    "pageCount": 4
}

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 making requests and handling responses and lets you focus on writing code specific to your particular project. Check out our [GitHub repository](https://github.com/groupdocs-parser-cloud for a complete list of GroupDocs.Parser Cloud SDKs along with working examples, to get you started in no time. Please check Available SDKs) article to learn how to add an SDK to your project.

Get Document Information Examples

C#

Java