Get all shapes on an Excel worksheet This REST API indicates Get worksheet shapes
RSET API
Copy
GET http://api.aspose.cloud/v3.0/cells/{ name} /worksheets/{ sheetName} /shapes
The request parameters are:
Parameter Name
Type
Path/Query String/HTTPBody
Description
name
string
path
document name.
sheetName
string
path
worksheet name.
folder
string
query
Document’s folder.
storageName
string
query
storage name.
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
Copy
curl -v "https://api.aspose.cloud/v3.0/cells/Book1.xlsx/worksheets/Sheet1/shapes" \
-X GET \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"
Response
Copy
{
"Shapes" : {
"ShapeList" : [
{
"link" : {
"Href" : "/0" ,
"Rel" : "self" ,
"Type" : null,
"Title" : null
}
} ,
{
"link" : {
"Href" : "/1" ,
"Rel" : "self" ,
"Type" : null,
"Title" : null
}
} ,
{
"link" : {
"Href" : "/2" ,
"Rel" : "self" ,
"Type" : null,
"Title" : null
}
} ,
{
"link" : {
"Href" : "/3" ,
"Rel" : "self" ,
"Type" : null,
"Title" : null
}
}
] ,
"link" : {
"Href" : "http://api.aspose.com/v1.1/cells/sampleShapes.xlsx/worksheets/Sheet1/shapes" ,
"Rel" : "self" ,
"Type" : null,
"Title" : null
}
} ,
"Code" : 200,
"Status" : "OK"
}
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:
C#
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
namespace Aspose.Cells.Cloud.SDK.Tests.Api.Example
{
using Microsoft.VisualStudio.TestTools.UnitTesting;
using Aspose.Cells.Cloud.SDK.Request;
using System.Collections.Generic;
using Aspose.Cells.Cloud.SDK.Api;
using System;
using System.IO;
[TestClass]
public class CellsApiExample
{
string CellsCloudClientId ="....";//get from https://dashboard.aspose.cloud/#/applications
string CellsCloudClientSecret="...";//get from https://dashboard.aspose.cloud/#/applications
private readonly string remoteFolder = "TestData/In";
string localName = "Book1.xlsx";
string remoteName = "remote_book1.xlsx";
string localPath = "D:/TestData/CellsCloud";
[TestCategory("Cells")]
[TestMethod]
public void Example()
{
UploadFileRequest uploadFileRequest = new UploadFileRequest();
FileInfo fileInfo = new FileInfo(localPath + "/" + localName);
uploadFileRequest.path = remoteFolder + "/" + remoteName;
uploadFileRequest.storageName = "";
uploadFileRequest.UploadFiles = new Dictionary<string, Stream>() { { localName, File.OpenRead(localPath +"/"+ localName) } };
cellsApi.UploadFile(uploadFileRequest);
var request = new GetWorksheetShapesRequest(
name: remoteName,
sheetName: "Sheet1",
folder: remoteFolder
);
cellsApi.GetWorksheetShapes(request);
}
}
}
Java
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 java.io.IOException;
import org.junit.Test;
import java.util.ArrayList;
import java.util.List;
import java.io.File;
import java.util.HashMap;
public class Example {
private CellsApi api;
public Example(){
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 remoteFolder = "TestData/In";
String localName = "Book1.xlsx";
String remoteName = "Book1.xlsx";
UploadFileRequest uploadFileRequest = new UploadFileRequest();
uploadFileRequest.setPath( remoteFolder + "/" + remoteName );
uploadFileRequest.setStorageName( "");
HashMap<String,File> files = new HashMap<String,File>();
files.put( localName , new File(localName ));
uploadFileRequest.setUploadFiles(files);
api.uploadFile(uploadFileRequest);
GetWorksheetShapesRequest request = new GetWorksheetShapesRequest();
request.setName(remoteName);
request.setSheetName("Sheet1");
request.setFolder(remoteFolder);
request.setStorageName("");
ShapesResponse response = api.getWorksheetShapes(request);
} catch (ApiException e) {
e.printStackTrace();
}catch (IOException e) {
e.printStackTrace();
}
}
}
Perl
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-perl/
use strict;
use warnings;
use utf8;
use File::Slurp;
use MIME::Base64;
use AsposeCellsCloud::CellsApi;
my $config = AsposeCellsCloud::Configuration->new( client_id => $ENV{'ProductClientId'}, client_secret => $ENV{'ProductClientSecret'});
my $instance = AsposeCellsCloud::CellsApi->new(AsposeCellsCloud::ApiClient->new( $config));
my $remoteFolder = 'TestData/In';
my $remoteName = 'Book1.xlsx';
my $request = AsposeCellsCloud::Request::GetWorksheetShapesRequest->new();
$request->{name} = $remoteName;
$request->{sheet_name} = 'Sheet1';
$request->{folder} = $remoteFolder;
$request->{storage_name} = '';
my $result = $instance->get_worksheet_shapes(request=> $request);
Go
Swift