EditGrid Developer Portal
Back to EditGrid
Documentation / Web API
Methods
auth
createSessionKey
createToken
getSessionInfo
getSessionKey
cell
clear
insert
list
set
setInput
setSize
setStyle
revision
create
get
mark
query
rollback
unmark
share
delete
get
query
set
sheetObject
list
user
create
delete
get
list
query
workbook
clone
create
createAccessToken
createRemote
delete
export
get
import
list
purge
query
restore
update
worksheet
create
delete
get
list
move
update
updateLinked
workspace
create
get
Entities
Binary
Cell
Error
Revision
SessionInfo
Share
SheetObject
Style
User
Workbook
Worksheet
Workspace
API Method
workbook.purge
Purge a workbook.
Authentication
Requires a valid
session key
obtained from calling
auth.getSessionKey
, passed as parameter "s" (HTTP-RPC) or "sessionKey" (SOAP) to authenticate your call.
Parameters
Name
Type
Req
workbook
int
*
The id of the workbook.
Request Body
This method requires no request body.
Return Value
int
Always return 1.
For enquiries, please contact
cs@editgrid.com
, or
visit our user forum
.