Save Workbooks
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API adds or updates a Workbook entity in the given entity’s JSON. To use this API with hasWorksheets=true, hasShortcuts=true, or both, the user must have privileges to import and export objects.
Method: POST
Request URL: {kyvos-url}/rest/v2/workbooks/bulk
Authorization
API Key: sessionid
This method authenticates requests using a session ID which acts like an API key.
BasicAuth: HTTP Authorization Scheme
This method authenticates requests using a username and password sent in the HTTP Authorization header.
Headers
Header Name | Type | Description | Possible Values |
|---|---|---|---|
Content-Type (Required) | String | Specifies the media type of the request body. |
|
sessionid | String | The session ID is the token received from the login API. Note: Session ID is required for token-based authentication. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
json (Required) | String | JSON of the Workbook entity to be saved. Note: A sample JSON example is provided under the Resources section below. | – |
hasWorksheets | Boolean | Indicates that the Workbook JSON also contains Worksheets JSON. The save operation will include the Worksheets accordingly. |
Default: |
hasShortcuts | Boolean | Indicates that the Workbook JSON also contains Shortcuts JSON. The save operation will include the Shortcuts accordingly. |
Default: |
Responses
200 Success
{
"code": 0,
"message": "Successfully updated workbook: cte_rolap 1"
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Parameter missing. |
500 | Internal Server Error |
Resources
Below is an example of JSON structure which can be used as a reference for the json parameter in the request body.
{
"iro":{
"entityRepositDate":"1776774861573",
"ownerAppId":"154854747",
"linkedEntityId":"",
"type":"WORKBOOK",
"specific":{
"worksheets":[
{
"owner":"admin",
"name":"Sheet 1",
"vizType":"TABLECONTROL",
"id":"Sheet17767748075688127083031119833531",
"lastModified":"04/21/2026 18:04:21",
"accessRights":"1",
"type":"SHEET",
"ownerId":"",
"lastModifiedTimestamp":"1776774861612"
}
],
"calculatedMeasures":{
},
"dynamicMembers":{
},
"parameters":[
]
},
"folderId":"folder_17754745110577127079056138147986",
"designSource":"DESIGNER",
"ownerAppName":"admin",
"common":{
"compatibilityVersion":"1",
"desc":"",
"tags":""
},
"entityState":"",
"name":"cte_rolap",
"isPublic":true,
"subType":"",
"repositDate":"04/21/2026 18:04:21 IST",
"id":"Workbook17767747973146127029072117047065",
"folderName":"test",
"accessRights":"1",
"categoryId":"folder_17754745110577127079056138147986"
}
}