Blogs Forums Contact Us Sheet Home Toll Free : 888 900 9646

API Methods >> zohoSheet.userView.getWorkbooks

Description

To get the list of workbooks available in your Zoho Sheet account. It's also possible to give some additional criteria to limit the number of workbooks detail returned by this method.

Arguments

startIndex [ optional ; datatype - integer ]
- The index from where the wokbook retrieval should start. For example, if startIndex is specified as 3, the first two workbooks detail will be left out and details will be returned from third workbook onwards.
- If value for this argument is not specified, it's value will be considered as 1 by default.
noOfBooks [ optional ; datatype - integer ]
- number of workbook(starting from above startIndex) details to be returned by this method
- If value for this argument is not specified, details of all the workbooks will be return
sortBy [ optional ; datatype - enumeration {createdTime | lastModifiedTime | name } ]
- The workbook property { createdTime | lastModifiedTime | name } , by which the list of workbooks detail returned by this method would have been sorted
- If value for this argument is not specified, the returned workbook list will be sorted by the property 'createdTime'
isAscending [ optional ; datatype - boolean ]
- This argument is used for specifying the sort order i.e ascending or descending
- If value for this argument is not specified, sorting will be done on descending order

Returns

A list of workbooks created by that user and their associated details. For each workbook, in addition to normal properties like workbook name,created time etc, two additional properties 'workbookId' and 'updateLock' will be returned.

workbookId - this is a unique Id representing the workbook inside the Zoho Sheet account. Subsequently, this workbookId needs to be passed to other API methods which manipulates this workbook.
updateLock - With opening up of APIs, now it becomes possible to send concurrent update requests to a same workbook. This 'updateLock' property acts like a advisory lock which ensures that updates made to workbook are consistent.Thus,this updateLock should be passed to API methods which modifies the workbook ( like saveWorkbook )

A Sample Call to zohoSheet.userView.getWorkbooks

Request


<methodCall>
    <methodName>zohosheet.userView.getWorkbooks</methodName>
    <params>
 <param>
 <name>startIndex</name>
            <value>6</value>
 </param>
        <param>
            <name>noOfBooks</name>
 <value>5</value>
        </param>
        <param>
            <name>sortBy</name>
            <value>lastModifiedTime</value>
        </param>
        <param>
            <name>isAscending</name>
            <value>true</value>
        </param>
    </params>
</methodCall>

Response


<?xml version="1.0" encoding="UTF-8" ?>
<methodResponse methodName="zohosheet.userView.getWorkbooks">
    <result>
        <workbook>
            <workbookId>5000000000050</workbookId>
            <workbookName>Welcome</workbookName>
            <createdTime>2006-11-14 16:56:00</createdTime>
            <lastModifiedTime>2006-11-14 17:02:31</lastModifiedTime>
	    <lastModifiedBy>samjackson</lastModifiedBy>
            <isLocked>false</isLocked>
            <updateLock>1163503951125</updateLock>
        </workbook>
        <workbook>
            <workbookId>5000000000060</workbookId>
            <workbookName>Budget_planner</workbookName>
            <createdTime>2006-11-14 16:58:34</createdTime>
            <lastModifiedTime>2006-11-14 17:01:16</lastModifiedTime>
	    <lastModifiedBy>samjackson</lastModifiedBy>
            <isLocked>false</isLocked>
            <updateLock>1163503876046</updateLock>
        </workbook>
    </result>
</methodResponse>