Save Worksheets
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API adds or updates Worksheet entities from the provided JSON. Since this API performs a bulk operation, the user must have privileges to import and export objects to use this API.
Method: POST
Request URL: {kyvos-url}/rest/v2/worksheets/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 media type of 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 Worksheet entity to be saved. Note: A sample JSON example is provided under the Resources section below. | – |
Responses
200 Success
{
"res": [
{
"code": 0,
"entityId": "Dashboard177981291678641270340441837601160",
"message": "Successfully updated worksheet: Group Card_Rest",
"extMessage": ""
}
]
}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":"1779812973099",
"ownerAppId":"28727",
"linkedEntityId":"",
"type":"WORKSHEET",
"specific":{
"worksheet":{
"owner":"kyvos",
"viewerWidth":"1200",
"lastModified":"05/26/2026 22:00:06 IST",
"accessRights":"1",
"type":"DASHBOARD",
"ownerId":"28727",
"title":"",
"workbookId":"Workbook17798125010439127069032198287881",
"lastModifiedTimestamp":"1779813006123",
"dashboard":{
"layout":{
"layoutProps":{
"dbwidget17798129210042127040020162811280":{
"isShowMaximize":false,
"col":null,
"sizeX":128,
"isNoDataOnWidget":false,
"isWidgetPinned":true,
"row":null,
"sizeY":96
},
"dbwidget17798129210046127082070111190347":{
"isShowMaximize":false,
"col":null,
"sizeX":128,
"isNoDataOnWidget":false,
"isWidgetPinned":true,
"row":null,
"sizeY":96
},
"dbwidget17798129288439127029013175379805":{
"isShowMaximize":false,
"col":1,
"sizeX":128,
"isNoDataOnWidget":false,
"isWidgetPinned":false,
"row":1,
"sizeY":106
},
"dbwidget17798129210043127083020171462106":{
"isShowMaximize":false,
"col":0,
"sizeX":128,
"isNoDataOnWidget":false,
"isWidgetPinned":true,
"row":0,
"sizeY":96
},
"DB_PROPS":{
"canvasWidth":1342,
"pageBreak":{
"AUTO":[
],
"footerHeight":50,
"headerFooterType":"NONE",
"showPageBreak":false,
"CUSTOM":[
],
"headerHeight":50,
"type":"NONE",
"autoPagebreakHeight":1000
},
"columnWidth":4
},
"dbwidget17798129313014127091097121446193":{
"isShowMaximize":false,
"col":129,
"sizeX":116,
"isNoDataOnWidget":false,
"isWidgetPinned":false,
"row":1,
"sizeY":41
}
},
"type":"FIXED",
"hideWidgetsState":false,
"colorPaletteId":"None",
"widgetsPerRow":""
},
"dashboardStyle":{
"widgetGap":8,
"backgroundColor":"",
"loaderStyle":"GHOST_LOADER",
"widgetShadow":2,
"dashboardMargin":{
"all":8,
"top":8,
"left":8,
"bottom":8,
"isAllMargin":true,
"right":8
},
"customCss":""
},
"theme":{
"name":"None",
"id":""
},
"widgets":{
"widget":[
{
"isIncludeActionFiltersToFetchRelevantValues":false,
"legendProps":{
"arrangement":"free-flow",
"enable":false,
"isInheritFromSheet":true,
"position":"top"
},
"uiIdentifier":"standard",
"groupId":"group_17798129246929127092046175771835",
"type":"SHEET",
"title":"HighlightingAndTopn",
"layoutProperty":{
"columnDetails":[
]
},
"layerIndex":1,
"inheritSheetDescription":true,
"sheetId":"Sheet17798125117959127082034144143820",
"id":"dbwidget17798129210043127083020171462106",
"isCustomTitle":false,
"widgetStyle":{
"contentAlignment":"",
"backgroundColor":"",
"isWidgetPositionFixed":false,
"hideScrollbar":false
}
},
{
"isIncludeActionFiltersToFetchRelevantValues":false,
"legendProps":{
"arrangement":"free-flow",
"enable":true,
"isInheritFromSheet":true,
"position":"top"
},
"uiIdentifier":"standard",
"groupId":"group_17798129258303127055094188547678",
"type":"SHEET",
"title":"MeasureFIlter",
"layoutProperty":{
"columnDetails":[
]
},
"layerIndex":1,
"inheritSheetDescription":true,
"sheetId":"Sheet17798126184160127096095145753957",
"id":"dbwidget17798129210046127082070111190347",
"isCustomTitle":false,
"widgetStyle":{
"contentAlignment":"",
"backgroundColor":"",
"isWidgetPositionFixed":false,
"hideScrollbar":false
}
},
{
"isIncludeActionFiltersToFetchRelevantValues":false,
"legendProps":{
"arrangement":"free-flow",
"enable":true,
"isInheritFromSheet":true,
"position":"top"
},
"uiIdentifier":"standard",
"groupId":"group_17798129273178127065024187392253",
"type":"SHEET",
"title":"Subquery",
"layoutProperty":{
"columnDetails":[
]
},
"layerIndex":1,
"inheritSheetDescription":true,
"sheetId":"Sheet17798127624522127013064174262808",
"id":"dbwidget17798129210042127040020162811280",
"isCustomTitle":false,
"widgetStyle":{
"contentAlignment":"",
"backgroundColor":"",
"isWidgetPositionFixed":false,
"hideScrollbar":false
}
},
{
"isIncludeActionFiltersToFetchRelevantValues":false,
"legendProps":{
"arrangement":"free-flow",
"enable":false,
"isInheritFromSheet":false,
"position":"right"
},
"displayAs":"TAB",
"uiIdentifier":"standard",
"groups":{
"activeGroup":"group_17798129246929127092046175771835",
"group":[
{
"groupId":"group_17798129246929127092046175771835",
"name":"Group 1",
"widgets":"dbwidget17798129210043127083020171462106"
},
{
"groupId":"group_17798129258303127055094188547678",
"name":"Group 2",
"widgets":"dbwidget17798129210046127082070111190347"
},
{
"groupId":"group_17798129273178127065024187392253",
"name":"Group 3",
"widgets":"dbwidget17798129210042127040020162811280"
}
]
},
"id":"dbwidget17798129288439127029013175379805",
"type":"TAB",
"isCustomTitle":true,
"layoutProperty":{
"columnDetails":[
]
},
"layerIndex":1,
"widgetStyle":{
"contentAlignment":"",
"backgroundColor":"",
"isWidgetPositionFixed":false,
"hideScrollbar":false
}
},
{
"isIncludeActionFiltersToFetchRelevantValues":true,
"legendProps":{
"arrangement":"free-flow",
"enable":false,
"isInheritFromSheet":false,
"position":"right"
},
"uiIdentifier":"standard",
"id":"dbwidget17798129313014127091097121446193",
"type":"FILTER",
"isCustomTitle":true,
"title":"Filter based on Order Date",
"filterCardDetail":{
"filterCardProperty":{
"isShowAddCaption":true,
"allowFieldValueToBeEmbedInline":false,
"isUseAsSharedFilterCard":false,
"filterModeManual":false,
"sharedCardIdentifier":""
},
"linkedWidgets":"dbwidget17798129210043127083020171462106,dbwidget17798129210046127082070111190347,dbwidget17798129210042127040020162811280,dbwidget17798129210043127083020171462106",
"linkedFilterWidgets":"",
"filters":{
"filter":[
{
"isMemberValue":true,
"fieldName":"DIM_18!!!DIMENSION_HIERARCHY_22!!!DIMENSION_LEVEL_39",
"firstValue":{
"content":"'Afghanistan','Albania'"
},
"searchContext":"ALL",
"includeCurrent":false,
"useField":false,
"fieldDisplayName":"Country",
"fieldEntityInfo":{
"dimName":"Geo",
"hierName":"H_Geo",
"type":"DIMENSION",
"isPartOfPreDefinedHierarchy":false,
"qualifiedName":""
},
"relation":"AND",
"useFieldType":"VALUE",
"isAppliedOnDisplayField":true,
"delimiter":"^`~",
"secondValue":{
"content":""
},
"valueType":"predefined",
"id":"qf1",
"nonVisual":false,
"firstDisplayValue":"Afghanistan^`~Albania",
"suspend":false,
"isParameter":false,
"topNField":"",
"valueBy":"VALUE",
"dataType":"CHAR",
"topNDisplayValue":"",
"endEnclosure":"",
"isSearchFilter":false,
"sortOrder":"ASC",
"startEnclosure":"",
"filterType":"QUICK",
"showInDataCard":false,
"secondDisplayValue":"",
"operation":"INLIST",
"fieldType":"DIMENSION",
"isIncludedForContextSearch":true
}
],
"qfDisplayAs":"Statement",
"showDimensionFilter":true,
"showMeasureFilter":false,
"showParameterFilter":false,
"allowFilterSuspension":true,
"cubeId":"undefined"
},
"cubeObject":{
"name":"Order Date",
"id":"16032701190267127072016117438809",
"folderName":"Kyvos_DataAccuracyCubes"
}
},
"layoutProperty":{
"columnDetails":[
]
},
"layerIndex":1,
"widgetStyle":{
"contentAlignment":"",
"backgroundColor":"",
"isWidgetPositionFixed":false,
"hideScrollbar":false
}
}
],
"isContainerCardExists":true
},
"isResponsivenessEnabled":false,
"exportCombinations":{
"filterCards":[
{
"filterCardId":"dbwidget17798129313014127091097121446193",
"filters":{
"filter":[
{
"isMemberValue":true,
"fieldName":"DIM_18!!!DIMENSION_HIERARCHY_22!!!DIMENSION_LEVEL_39",
"firstValue":{
"content":"'Afghanistan','Albania','Algeria'"
},
"searchContext":"ALL",
"includeCurrent":false,
"useField":false,
"fieldDisplayName":"Country",
"fieldEntityInfo":{
"dimName":"Geo",
"hierName":"H_Geo",
"qualifiedName":"",
"type":"DIMENSION",
"isPartOfPreDefinedHierarchy":false
},
"relation":"AND",
"useFieldType":"VALUE",
"isAppliedOnDisplayField":true,
"delimiter":"^`~",
"secondValue":{
"content":""
},
"valueType":"predefined",
"id":"qf1",
"nonVisual":false,
"firstDisplayValue":"Afghanistan^`~Albania^`~Algeria",
"suspend":false,
"isParameter":false,
"topNField":"",
"valueBy":"VALUE",
"dataType":"CHAR",
"topNDisplayValue":"",
"endEnclosure":"",
"isSearchFilter":false,
"sortOrder":"ASC",
"startEnclosure":"",
"filterType":"QUICK",
"showInDataCard":false,
"secondDisplayValue":"",
"operation":"INLIST",
"fieldType":"DIMENSION",
"isIncludedForContextSearch":true
}
],
"qfDisplayAs":"Statement",
"showDimensionFilter":true,
"showMeasureFilter":false,
"showParameterFilter":false,
"allowFilterSuspension":true,
"cubeId":"16032701190267127072016117438809"
},
"cubeObject":{
"name":"Order Date",
"id":"16032701190267127072016117438809",
"folderName":"Kyvos_DataAccuracyCubes"
}
}
]
}
}
}
},
"folderId":"folder_17798124991012127025020173529399",
"designSource":"DESIGNER",
"ownerAppName":"kyvos",
"common":{
"compatibilityVersion":"1",
"desc":"Description of Group Card",
"tags":""
},
"entityState":"",
"name":"Group Card_Rest",
"isPublic":true,
"subType":"DASHBOARD",
"repositDate":"05/26/2026 22:00:06 IST",
"id":"Dashboard177981291678641270340441837601160",
"folderName":"SARestAPiTesting",
"accessRights":"1",
"categoryId":"folder_17798124991012127025020173529399"
}
}