Batch Unlock

This REST API unlocks eligible Excel files in batch.

REST API

POST http://api.aspose.cloud/v3.0/cells/batch/unlock

Security and Authentication

The Aspose.Cells Cloud APIs are secure and require JWT token-based authentication.

Request Parameters

Parameter Name	Type	Location	Description
BatchLockRequest		body	Request body that contains the unlock settings.

BatchLockRequest Properties

Name	Type	Description	Notes
SourceFolder	string	Folder that contains the source Excel files.	[optional]
MatchCondition	MatchConditionRequest	Criteria used to select files for unlocking.	[optional]
Password	string	Password applied to protected workbooks.	[optional]
OutFolder	string	Destination folder for the unlocked files.	[optional]

MatchConditionRequest Properties

Name	Type	Description	Notes
RegexPattern	string	Regular expression to match file names.	[optional]
FullMatchConditions	string[]	Exact file name conditions to match.	[optional]

Request Body Parameter

Parameter Name	Type	Description
data	file	Binary content of the workbook file to create.

Response

{
    "Name": "ResponseFile",
    "DataType": {
        "Identifier": "File",
        "Reference": "Stream",
        "Name": "file"
    }
}

HTTP Status Codes

Code	Meaning	When Returned
200 OK	Workbook created successfully	Normal flow
201 Created	Workbook created (alternative response)	When the API returns a created status
400 Bad Request	Invalid parameters	Client‑side error
401 Unauthorized	Missing or invalid token	Authentication error
409 Conflict	File exists and `isWriteOver=false`	Conflict with existing file

How to Use the PostBatchLock API with SDKs

PostBatchLock API Specification

The OpenAPI Specification defines a publicly accessible programming interface and lets you carry out REST interactions directly from a web browser.

You can use the cURL command‑line tool to access Aspose.Cells web services easily. The following example shows how to make calls to the Cloud API with cURL.

Request

curl -v "http://api.aspose.cloud/v3.0/cells/batch/unlock" \
  -X POST \
  -H "Content-Type: application/json" \
  -H "Accept: application/json" \
  -H "Authorization: Bearer <jwt token>" \
  -d '{"SourceFolder":"CellsTests","OutFolder":"Output","MatchCondition":{"RegexPattern":"(^Book)(.+)(xlsx$)"},"Password":"123456"}'

Response

{
  "Code": 200,
  "Status": "OK"
}

Use Aspose.Cells Cloud SDKs

Using an SDK is the fastest way to develop unlock functionality. An SDK abstracts low‑level details so you can focus on your business logic. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

The following code examples demonstrate how to call Aspose.Cells web services using various SDKs: