Rename a
particular workbook.
Request URL : POST
XML :
http://sheet.zoho.com/api/private/xml/renamebook/[BookID]?apikey=[API Key]&ticket=[Ticket]
JSON :
http://sheet.zoho.com/api/private/json/renamebook/[BookID]?apikey=[API Key]&ticket=[Ticket]
Request parameters :
To rename a workbook in
Zoho Sheet we need to submit a form data to Zoho Sheet with the following
fields:
Field
|
Description
|
newName
|
[string] - New name assigned for the
workbook
|
Sample Form (POST Method)
<form method="POST"
action="http://sheet.zoho.com/api/private/xml/renamebook/15265000000006067?apikey=[APIKEY]&ticket=[Ticket]">
<input type="hidden"
name="newName" value="[Rename
Workbook]">
<input type="submit" value="RenameBook"
class="divbutton"
name="submit">
</form>
Response fields
Field
|
Description
|
workbookId
|
Unique ID associated with the workbook that is
being renamed.
|
workbookName
|
New name of the workbook.
|
modifiedTime
|
Number of milliseconds between the last
modified time and midnight, January 1, 1970 UTC.
|
updateLock
|
Advisory lock for update operation. Ensures
that updates made to workbook are consistent.
|
Sample Response
The following is the sample
XML response for the above method:
<?xml
version="1.0" encoding="UTF-8" ?>
<response uri="/api/private/xml/renamebook/15265000000006067">
<result>
<workbookId>15265000000006067</workbookId>
<workbookName>[New Name of
Workbook]</workbookName>
<modifiedTime>1174374756812</modifiedTime>
<updateLock>1174374756812</updateLock>
</result>
</response>
Equivalent JSON
response
{
"response":
{
"uri": "/api/private/json/renamebook/15265000000006067",
"result":
{
"workbookId":"15265000000006067",
"workbookName":"[New Name of
Workbook]",
"lastModifiedTime":1174374756812,
"updateLock":"1174374756812"
}
}
}
Errors
Renaming a workbook method may return general & input errors. Other specific HTTP error codes
include 2851,2852 & 2853
