Add This REST API indicates to add a worksheet hyperlink on an Excel worksheet.
RSET API
Copy
PUT 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
Worksheet name.
firstRow
integer
query
firstColumn
integer
query
totalRows
integer
query
totalColumns
integer
query
address
string
query
folder
string
query
The document 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.
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
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;
string CellsCloudClientId ="....";//get from https://dashboard.aspose.cloud/#/applications
string CellsCloudClientSecret="...";//get from https://dashboard.aspose.cloud/#/applications
string remoteFolder = "TestData/In";
string localName = "Book1.xlsx";
string remoteName = "Book1.xlsx";
var request = new PutWorksheetHyperlinkRequest(
name: remoteName,
sheetName: "Sheet1",
firstRow: 1,
firstColumn: 1,
totalRows: 2,
totalColumns: 3,
address: "https://products.aspose.cloud/cells/",
folder: remoteFolder,
storageName: ""
);
cellsApi.PutWorksheetHyperlink(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);
PutWorksheetHyperlinkRequest request = new PutWorksheetHyperlinkRequest();
request.setName(remoteName);
request.setSheetName("Sheet1");
request.setFirstRow(1);
request.setFirstColumn(1);
request.setTotalRows(2);
request.setTotalColumns(3);
request.setAddress("https://products.aspose.cloud/cells/");
request.setFolder(remoteFolder);
request.setStorageName("");
this.api.putWorksheetHyperlink(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
require_once('vendor\autoload.php');
use \Aspose\Cells\Cloud\Api\CellsApi;
use \Aspose\Cells\Cloud\Request\PutWorksheetHyperlinkRequest;
$CellsCloudClientId = "...." ; # get from https://dashboard.aspose.cloud/#/applications
$CellsCloudClientSecret = "...."; # get from https://dashboard.aspose.cloud/#/applications
$cellsApi = new CellsApi($CellsCloudClientId , $CellsCloudClientSecret );
$remoteFolder = "TestData/In";
$localName = "Book1.xlsx";
$remoteName = "Book1.xlsx";
$request = new PutWorksheetHyperlinkRequest();
$request->setName( $remoteName);
$request->setSheetName( "Sheet1");
$request->setFirstRow( 1);
$request->setFirstColumn( 1);
$request->setTotalRows( 2);
$request->setTotalColumns( 3);
$request->setAddress( "https://products.aspose.cloud/cells/");
$request->setFolder( $remoteFolder);
$request->setStorageName( "");
$cellsApi->putWorksheetHyperlink($request);
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
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)
remote_folder = 'TestData/In'
local_name = 'Book1.xlsx'
remote_name = 'Book1.xlsx'
mapFiles = { }
mapFiles[local_name] = ::File.open(File.expand_path("TestData/"+local_name),"r")
uploadrequest = AsposeCellsCloud::UploadFileRequest.new( { :UploadFiles=>mapFiles,:path=>remote_folder })
@instance.upload_file(uploadrequest)
request = AsposeCellsCloud::PutWorksheetHyperlinkRequest.new(:name=>remote_name,:sheetName=>'Sheet1',:firstRow=>1,:firstColumn=>1,:totalRows=>2,:totalColumns=>3,:address=>'https://products.aspose.cloud/cells/',:folder=>remote_folder,:storageName=>'');
@instance.put_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
import { CellsApi,PutWorksheetHyperlinkRequest,UploadFileRequest } from "asposecellscloud";
var fs = require('fs');
var path = require('path');
var process = require('process');
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 remoteFolder = "TestData/In"
var localPath = "TestData/CellsCloud/"
var localName = "Book1.xlsx"
var remoteName = "Book1.xlsx"
describe('example', function(){
it("should call successfully" , function(){
var localNameRequest = new UploadFileRequest();
localNameRequest.uploadFiles ={localName:fs.createReadStream(localPath + localName)};
localNameRequest.path = remoteFolder + "/" + remoteName ;
localNameRequest.storageName ="";
cellsApi.uploadFile(localNameRequest );
var request = new PutWorksheetHyperlinkRequest();
request.name = remoteName;
request.sheetName = "Sheet1";
request.firstRow = 1;
request.firstColumn = 1;
request.totalRows = 2;
request.totalColumns = 3;
request.address = "https://products.aspose.cloud/cells/";
request.folder = remoteFolder;
request.storageName = "";
return cellsApi.putWorksheetHyperlink(request)
});
});
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
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)
request = PutWorksheetHyperlinkRequest( 'Book1.xlsx', 'Sheet1', 1, 1, 2, 3, 'https://products.aspose.cloud/cells/',folder= 'PythonTest',storage_name= '')
api.put_worksheet_hyperlink(request)
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
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 $remoteFolder = 'TestData/In';
my $localName = 'Book1.xlsx';
my $remoteName = 'Book1.xlsx';
my $upload_file_request = AsposeCellsCloud::Request::UploadFileRequest->new( 'UploadFiles'=>{ $localName => $localName } ,'path'=>$remoteFolder . '/' . $remoteName );
my $request = AsposeCellsCloud::Request::PutWorksheetHyperlinkRequest->new();
$request->{name} = $remoteName;
$request->{sheet_name} = 'Sheet1';
$request->{first_row} = 1;
$request->{first_column} = 1;
$request->{total_rows} = 2;
$request->{total_columns} = 3;
$request->{address} = 'https://products.aspose.cloud/cells/';
$request->{folder} = $remoteFolder;
$request->{storage_name} = '';
$instance->put_worksheet_hyperlink(request=> $request);
Go
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 main
import (
. "github.com/aspose-cells-cloud/aspose-cells-cloud-go/v25"
)
func main() {
CellsCloudClientId := "...." // get from https://dashboard.aspose.cloud/#/applications
CellsCloudClientSecret := "...." // get from https://dashboard.aspose.cloud/#/applications
instance := NewCellsApiService(CellsCloudClientId, CellsCloudClientSecret)
remoteFolder := "TestData/In"
localName := "Book1.xlsx"
remoteName := "Book1.xlsx"
localNameRequest := new(UploadFileRequest)
localNameRequest.UploadFiles = make(map[string]string)
localNameRequest.UploadFiles[localName] = localName
localNameRequest.Path = remoteFolder + "/" + remoteName
localNameRequest.StorageName = ""
instance.UploadFile(localNameRequest)
request := new(PutWorksheetHyperlinkRequest)
request.Name = remoteName
request.SheetName = "Sheet1"
request.FirstRow = int64(1)
request.FirstColumn = int64(1)
request.TotalRows = int64(2)
request.TotalColumns = int64(3)
request.Address = "https://products.aspose.cloud/cells/"
request.Folder = remoteFolder
request.StorageName = ""
_, httpResponse, err := instance.PutWorksheetHyperlink(request)
if err != nil {
println(err.Error())
} else if httpResponse.StatusCode < 200 || httpResponse.StatusCode > 299 {
println("Fail")
}
}