Lock Excel files

This REST API indicates to lock Excel files.

RSET API

 
POST http://api.aspose.cloud/v3.0/cells/lock

The request parameters are:

Parameter Name	Type	Path/Query String/HTTPBody	Description
file	file	formData	File to upload
password	string	query

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

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

Request

 
curl -v "http://api.aspose.cloud/v3.0/cells/lock?password=123456" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>" \
-F 'xxxxx1=@xxxx1.xlsx' \
-F 'xxxxx2=@xxxx2.xlsx'

Response

{
    "Files":
    [
        { 
            "Filename":"xxxxx",
            "FileSize":274022,
            "FileContent":"-----Base64String--------"
        },
        { 
            "Filename":"xxxxx",
            "FileSize":274022,
            "FileContent":"-----Base64String--------"
        }
    ]
}

Cloud SDK Family

Using an SDK is the best way to speed up the development. An SDK takes care of low-level details and lets you focus on your project tasks. Please check out the GitHub repository for a complete list of Aspose.Cells Cloud SDKs.

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

	using Aspose.Cells.Cloud.SDK.Api;
	using Aspose.Cells.Cloud.SDK.Model;
	using Aspose.Cells.Cloud.SDK.Request;
	using System;
	using System.IO;
	using System.Collections.Generic;

	CellsApi cellsApi = new CellsApi("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx");
	string needlockXlsx = "needlock.xlsx";

	IDictionary<string, Stream> mapFiles =new Dictionary<string,Stream>();
	AddFileParameter(needlockXlsx,mapFiles);
	var request = new PostLockRequest(
	file: mapFiles,
	password: "123456"
	);
	this.CellsApi.PostLock(request);

view raw ExamplePostLock.cs hosted with ❤ by GitHub

Java

	package com.aspose.cloud.cells.api;

	import com.aspose.cloud.cells.client.*;
	import com.aspose.cloud.cells.model.*;
	import com.aspose.cloud.cells.request.*;

	import org.junit.Test;
	import java.util.ArrayList;
	import java.util.List;
	import java.io.File;
	import java.util.HashMap;

	public class ExamplePostLock {
	private CellsApi api;
	public ExamplePostLock(){
	try {
	api = new CellsApi(
	System.getenv("CellsCloudClientId"),
	System.getenv("CellsCloudClientSecret"),
	"v3.0",
	System.getenv("CellsCloudApiBaseUrl")
	);
	} catch (ApiException e) {
	e.printStackTrace();
	}
	}

	public void Run(){
	try{
	String needlockXlsx = "needlock.xlsx";


	PostLockRequest request = new PostLockRequest();
	request.setPassword("123456");


	HashMap<String,File> fileMap = new HashMap<String,File>();
	fileMap.put(needlockXlsx ,CellsApiUtil.GetFileHolder(needlockXlsx) );
	request.setFile(fileMap);
	this.api.postLock(request);

	} catch (ApiException e) {
	// TODO Auto-generated catch block
	e.printStackTrace();
	}
	}
	}

view raw Example_PostLock.java hosted with ❤ by GitHub

PHP

	<?php
	require_once('vendor\autoload.php');
	use \Aspose\Cells\Cloud\Api\CellsApi;
	use \Aspose\Cells\Cloud\Request\PostLockRequest;

	$CellsCloudClientId = "...." ; # get from https://dashboard.aspose.cloud/#/applications
	$CellsCloudClientSecret = "...."; # get from https://dashboard.aspose.cloud/#/applications
	$cellsApi = new CellsApi($CellsCloudClientId , $CellsCloudClientSecret );

	$needlockXlsx = "needlock.xlsx";

	$mapFiles = array ();
	$mapFiles[$needlockXlsx] = CellsApiTestBase::getfullfilename($needlockXlsx);

	$request = new PostLockRequest();
	$request->setFile( $mapFiles);
	$request->setPassword( "123456");
	$$cellsApi->postLock($request);

view raw Example_PostLock.php hosted with ❤ by GitHub

Ruby

	require 'openssl'
	require 'bundler'
	require 'aspose_cells_cloud'


	CellsCloudClientId = "...." # get from https://dashboard.aspose.cloud/#/applications
	CellsCloudClientSecret = "...." # get from https://dashboard.aspose.cloud/#/applications
	@instance = AsposeCellsCloud::CellsApi.new(CellsCloudClientId, CellsCloudClientSecret)

	needlock_xlsx = 'needlock.xlsx'


	mapFiles = { }
	mapFiles[needlock_xlsx]= ::File.open(File.expand_path("TestData/"+needlock_xlsx),"r")
	request = AsposeCellsCloud::PostLockRequest.new(:File=>mapFiles,:password=>'123456');
	@instance.post_lock(request);

view raw Example_PostLock.rb hosted with ❤ by GitHub

Node.js

	var fs = require('fs');
	var path = require('path');
	const _ = require('asposecellscloud');

	const CellsCloudClientId ="....";//get from https://dashboard.aspose.cloud/#/applications
	const CellsCloudClientSecret="...";//get from https://dashboard.aspose.cloud/#/applications
	const cellsApi = new CellsApi(CellsCloudClientId, CellsCloudClientSecret);


	var needlockXlsx = "needlock.xlsx"


	var mapFiles = {};

	mapFiles[needlockXlsx]= fs.createReadStream(localPath +needlockXlsx) ;

	var request = new model.PostLockRequest();
	request.file = mapFiles;
	request.password = "123456";
	return cellsApi.postLock(request).then((result) => {
	expect(result.response.statusCode).to.equal(200);
	});

view raw Example_PostLock.ts hosted with ❤ by GitHub

Python

	import os
	import sys

	from asposecellscloud.apis.cells_api import CellsApi
	from asposecellscloud.models import *
	from asposecellscloud.requests import *

	CellsCloudClientId ='....' # get from https://dashboard.aspose.cloud/#/applications
	CellsCloudClientSecret='....' # get from https://dashboard.aspose.cloud/#/applications
	api = CellsApi(CellsCloudClientId,CellsCloudClientSecret)
	needlock_xlsx = 'needlock.xlsx'

	mapFiles = {
	needlock_xlsx: os.path.dirname(os.path.realpath(__file__)) + "/../TestData/" +needlock_xlsx
	}

	request = PostLockRequest( mapFiles, '123456')
	api.post_lock(request)

view raw Example_PostLock.py hosted with ❤ by GitHub

Perl

	use lib 'lib';
	use strict;
	use warnings;
	use File::Slurp;
	use MIME::Base64;
	use AsposeCellsCloud::CellsApi;

	my $CellsCloudClientId = "...."; # get from https://dashboard.aspose.cloud/#/applications
	my $CellsCloudClientSecret = "...."; # get from https://dashboard.aspose.cloud/#/applications
	my $config = AsposeCellsCloud::Configuration->new( client_id => $CellsCloudClientId , client_secret => $CellsCloudClientSecret );

	my $instance = AsposeCellsCloud::CellsApi->new(AsposeCellsCloud::ApiClient->new( $config));


	my $needlockXlsx = 'needlock.xlsx';


	my $mapFiles = {};

	$mapFiles->{$needlockXlsx}= "TestData/".$needlockXlsx ;

	my $request = AsposeCellsCloud::Request::PostLockRequest->new();
	$request->{file} = $mapFiles;
	$request->{password} = '123456';
	$instance->post_lock(request=> $request);

view raw Example_PostLock.pl hosted with ❤ by GitHub

	package main

	import (
	"os"

	asposecellscloud "github.com/aspose-cells-cloud/aspose-cells-cloud-go"
	)
	func main() {
	instance := asposecellscloud.NewCellsApiService(os.Getenv("ProductClientId"), os.Getenv("ProductClientSecret"), "https://api.aspose.cloud", "v3.0")
	needlockXlsx := "needlock.xlsx"


	var mapFiles map[string]string
	mapFiles = make(map[string]string)
	mapFiles[needlockXlsx]= GetBaseTest().localTestDataFolder + needlockXlsx

	request := new (asposecellscloud.PostLockRequest)
	request.File = mapFiles
	request.Password = "123456"
	_, httpResponse, err := instance.PostLock(request)
	if err != nil {
	t.Error(err)
	} else if httpResponse.StatusCode < 200 \|\| httpResponse.StatusCode > 299 {
	t.Fail()
	}
	}

view raw Example_PostLock.go hosted with ❤ by GitHub

Unprotect an Excel workbook Set modify password of an Excel workbook