Compare two documents
Contents
[
Hide
]
Comparing documents is often used to track changes made to important documents. Additionally, it is used in editing to compare the modified document version with the original.
Aspose.Words REST API is a powerful document manipulation tool that allows developers to compare two documents and retrieve the differences between them.
As a result of the comparison, a list of differences between the two Word documents is returned. Each difference will contain information about the type of difference (e.g. deleted text, added text, formatting change), the location of the difference in the document, and the text that was added or deleted.
Compare two documents REST API
Server: https://api.aspose.cloud/v4.0
| Method | Endpoint |
|---|---|
| PUT | /words/online/put/compareDocument |
| Parameter Name | Data Type | Required/Optional | Description |
|---|---|---|---|
loadEncoding |
string | Optional | Encoding that will be used to load an HTML (or TXT) document if the encoding is not specified in HTML. |
password |
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. |
encryptedPassword |
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. |
destFileName |
string | Optional | Result path of the document after the operation. If this parameter is omitted then result of the operation will be saved as the source document. |
encryptedPassword2 |
string | Optional | encrypted password for the second document. |
Note: Requires Client Id and Secret. See Quick Start to obtain credentials.
Response
Response model: DocumentResponse
| Field | Type | Description |
|---|---|---|
| Model | DocumentResponse | The REST response with a document description. |
| Document | FilesCollection | The document after modification. |
Error reference
| Status | Code | Description | Resolution |
|---|---|---|---|
| 400 | bad_request |
Invalid parameter value or missing required field | Check the parameter format and ensure all required fields are provided |
| 401 | unauthorized |
Missing or invalid access token | Obtain a new access token via the authentication endpoint |
| 403 | forbidden |
Access to the requested resource is denied | Verify that the access token has the required permissions |
| 404 | not_found |
The requested resource does not exist | Check the resource ID or path for typos |
| 429 | rate_limited |
Too many requests — rate limit exceeded | Wait for the Retry-After period before making another request |
| 500 | internal_error |
An unexpected server error occurred | Retry the request after a short delay; contact support if the issue persists |
Usage examples
REST API
SDK
See Also
- Cloud SDKs — Create, Edit, Convert and Render Word documents via REST API.