Get general information about
Contents[ Hide ]
Get general information about a Word document.
Get general information about a Word document REST API
documentName(required) — the filename of the input document.
You can use the following parameters in a REST request:
|Parameter Name||Data Type||Required/Optional||Description|
||string||Optional||Original document folder.|
||string||Optional||Original document storage.|
||string||Optional||Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML.|
||string||Optional||Password of protected Word document. Use the parameter to pass a password via SDK. SDK encrypts it automatically. We don’t recommend to use the parameter to pass a plain password for direct call of API.|
||string||Optional||Password of protected Word document. Use the parameter to pass an encrypted password for direct calls of API. See SDK code for encyption details.|
Note: to access this REST API, you need to register and get personal credentials. Use the ‘Quick Start’ guide to go through the procedure in a couple of minutes.
Get general information about a Word document usage examples
How to get general information about a Word document with cURL or Postman
One of the easiest and fastest ways to call a REST API is to use cURL or Postman:
Using SDK is the quickest way to speed up the development. Please take a look at the provided code examples to quickly call this web service from your favourite programming language:
- GitHub repository — explore Aspose.Words Cloud SDK Family. These software libraries take care of all low-level document-processing details.