Get Document Information

Introduction

This REST API allows to obtain basic information about the document. Endpoint accepts document storage path as input payload.

Here are the list of properties that can be obtained for a document:

  • Document file extension;
  • Document size in bytes;
  • Document file format;
  • Document page count;
  • Document encryption indicator.

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|Could be omitted for default storage.

Resource URI


HTTP POST ~/info

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

cURL Example

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

Response


{
    "fileType": {
        "fileFormat": "Microsoft Word Open XML Document",
        "extension": ".docx"
    },
    "size": 10240,
    "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 for a complete list of GroupDocs.Metadata 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.

SDK Examples

C#

Java