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.
Name
Description
Comment
FileInfo.FilePath
The path of the document, located in the storage.
Required.
FileInfo.StorageName
Storage name
It could be omitted for default storage.
FileInfo.Password
The password to open file
It should be specified only for password-protected documents.
ContainerItemInfo.RelativePath
The relative path of the container.
Should be specified only for container files like ZIP archives, emails or PDF portfolios.
ContainerItemInfo.Password
Password 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.
# First get JSON Web Token# Please get your Client Id and Client Secret from https://dashboard.groupdocs.cloud/applications.# Kindly place Client Id in "client_id" and Client Secret in "client_secret" 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 informationcurl -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' }"
{"fileType":{"fileFormat":"Microsoft Word Open XML Document","extension":".docx"},"size":8651,"pageCount":4}
SDK examples
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 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.
Was this page helpful?
Any additional feedback you'd like to share with us?
Please tell us how we can improve this page.
Thank you for your feedback!
We value your opinion. Your feedback will help us improve our documentation.