Get all This REST API indicates to get all hyperlinks on an Excel worksheet.
RSET API
Copy
GET http://api.aspose.cloud/v3.0/cells/{ name} /worksheets/{ sheetName} /hyperlinks
The request parameters are:
Parameter Name
Type
Path/Query String/HTTPBody
Description
name
string
path
Document name.
sheetName
string
path
The 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/test.xlsx/worksheets/Sheet1/hyperlinks" \
- X GET \
- H "Content-Type: application/json" \
- H "Accept: application/json" \
- H "Authorization: Bearer <jwt token>" Response
Copy
{
"Hyperlinks" : {
"Count" : 4 ,
"HyperlinkList" : [
{
"link" : {
"Href" : "/0" ,
"Rel" : "self" ,
"Title" : null ,
"Type" : null }
},
{
"link" : {
"Href" : "/1" ,
"Rel" : "self" ,
"Title" : null ,
"Type" : null }
},
{
"link" : {
"Href" : "/2" ,
"Rel" : "self" ,
"Title" : null ,
"Type" : null }
},
{
"link" : {
"Href" : "/3" ,
"Rel" : "self" ,
"Title" : null ,
"Type" : null }
}
],
"link" : 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
// For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-dotnet/
namespace Aspose.Cells.Cloud.SDK.Example
{
using Aspose.Cells.Cloud.SDK.Api;
using Aspose.Cells.Cloud.SDK.Request;
using System;
public partial class CellsApiExample
{
public void GetWorksheetHyperlinkExample()
{
string CellsCloudClientId ="....";//get from https://dashboard.aspose.cloud/#/applications
string CellsCloudClientSecret="...";//get from https://dashboard.aspose.cloud/#/applications
GetWorkSheetHyperlinkRequest request = new GetWorkSheetHyperlinkRequest
{
name = "Book1.xlsx",
sheetName = "Sheet1",
hyperlinkIndex = 1,
folder = "TestData/In"
};
cellsApi.GetWorkSheetHyperlink(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);
GetWorksheetHyperlinkRequest request = new GetWorksheetHyperlinkRequest();
request.setName(remoteName);
request.setSheetName("Sheet1");
request.setHyperlinkIndex(0);
request.setFolder(remoteFolder);
request.setStorageName("");
HyperlinkResponse response = api.getWorksheetHyperlink(request);
} catch (ApiException e) {
e.printStackTrace();
}catch (IOException e) {
e.printStackTrace();
}
}
}
PHP
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
<?php
# For complete examples and data files, please go to https://github.com/aspose-cells-cloud/aspose-cells-cloud-php
require_once('vendor\autoload.php');
use \Aspose\Cells\Cloud\Api\CellsApi;
use \Aspose\Cells\Cloud\Request\GetWorksheetHyperlinkRequest;
class Hyperlink {
public $instance;
public function __construct() {
$this->instance = new CellsApi(getenv("CellsCloudClientId"),getenv("CellsCloudClientSecret"),"v3.0",getenv("CellsCloudApiBaseUrl"));
}
public function getWorkSheetHyperlink() {
$remoteFolder = "TestData/In";
$localName = "Book1.xlsx";
$remoteName = "Book1.xlsx";
$request = new GetWorksheetHyperlinkRequest();
$request->setName( $remoteName);
$request->setSheetName( "Sheet1");
$request->setHyperlinkIndex( 0);
$request->setFolder( $remoteFolder);
$request->setStorageName( "");
$this->instance->getWorksheetHyperlink($request);
}
}
$hyperlink = new Hyperlink();
$hyperlink->getWorkSheetHyperlink();
?>
Ruby
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-ruby
require 'aspose_cells_cloud'
class Hyperlink
include AsposeCellsCloud
def initialize
#Get client_id and client_secret from https://cloud.aspose.com
@instance = AsposeCellsCloud::CellsApi.new($client_id,$client_secret,$api_version,$baseurl)
end
# Get worksheet hyperlinks.
def get_worksheet_hyperlinks
name = $BOOK1
sheet_name = $SHEET1
folder = $TEMPFOLDER
result = @instance.upload_file( folder+"/"+name, ::File.open(File.expand_path("data/"+name),"r") {|io| io.read(io.size) })
expect(result.uploaded.size).to be > 0
result = @instance.cells_hypelinks_get_worksheet_hyperlinks(name, sheet_name, { :folder=>folder})
expect(result.code).to eql(200)
end
end
hyperlink = Hyperlink.new()
puts hyperlink.get_worksheet_hyperlinks
Python
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-python
import os
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)
request = GetWorksheetHyperlinkRequest( 'Book1.xlsx', 'Sheet1', 0,folder= 'PythonTest',storage_name= '')
api.get_worksheet_hyperlink(request)
Node.js
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
const { CellsApi, UploadFileRequest, CellsHypelinks_GetWorksheetHyperlinkRequest } = require("asposecellscloud");
const clientId = process.env.CellsCloudClientId;
const clientSecret = process.env.CellsCloudClientSecret;
const ApiURL = process.env.CellsCloudApiBaseUrl;
const fs = require('fs');
const path = require('path');
const cellsApi = new CellsApi(clientId, clientSecret,"v3.0",ApiURL);
const localPath = "D:/aspose-cells-cloud-node/TestData/"
const filename = "Book1.xlsx";
const data =fs.createReadStream(path.join(localPath, filename));
const req = new UploadFileRequest({
path: "Temp/" + filename,
file: data
});
cellsApi.uploadFile(req)
.then((result) => {
const req = new CellsHypelinks_GetWorksheetHyperlinkRequest();
req.name = filename;
req.sheetName = "Sheet1";
req.hyperlinkIndex = 0;
req.folder = "Temp";
cellsApi.cellsHypelinksGetWorksheetHyperlink(req)
.then((result) => {
console.log("successful")
}).catch((error) => {
console.error('Unhandled Promise Rejection:', error);
})
})
Android
Swift
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::GetWorksheetHyperlinksRequest->new();
$request->{name} = $remoteName;
$request->{sheet_name} = 'Sheet1';
$request->{folder} = $remoteFolder;
$request->{storage_name} = '';
my $result = $api->get_worksheet_hyperlinks(request=> $request);
Go
