Add or Update Workbook Shortcut
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API adds or updates shortcuts of the Workbook.
Method: POST
Request URL: {kyvos-url}/rest/v2/workbooks/{name-or-id}/shortcut
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. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the Workbook in which the shortcut will be added or updated. Note: If the Workbook name is provided, then either folderName or folderId must also be provided. | – |
Query Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
by | String | Specifies whether the name-or-id parameter should be interpreted as a Workbook name or Workbook ID. If by=name, provide the Workbook name in the name-or-id parameter. If by=id, provide the Workbook ID in the name-or-id parameter. The default value is name. | – |
folderName | String | Name of the folder containing the Workbook. If the Workbook is present in the root directory, specify Note: If neither folderName nor folderId is provided, the Workbook will be treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the Workbook. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
shortcutJson (Required) | String | JSON object containing the shortcut details to be added or updated in the Workbook. Note: A sample JSON example is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Shortcut 'Shortcut 100' saved successfully"
}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 shortcutJson parameter in the request body.
{
"iro":{
"entityRepositDate":"1779366288149",
"ownerAppId":"402556674",
"linkedEntityId":"6BB67D66-4CDB-43C8-E19F-A6DA7BAB1ABC",
"type":"SHORTCUT",
"specific":{
"sourceEntitySubType":"SHEET",
"sourceEntityType":"WORKSHEET",
"sourceEntityId":"Sheet17793662879146127019046134297563",
"sourceEntityName":"Between_filter_date",
"entity":{
"sheet":{
"olapLayout":{
"visualization":{
"vizArray":[
],
"chartType":"",
"currentView":"",
"type":""
},
"showParameterFilter":true,
"isFilterModeManual":false,
"filters":{
"filter":[
{
"isMemberValue":true,
"fieldName":"DIM_328688!!!DIMENSION_ATTRIBUTE_547593",
"firstValue":{
"isFromPreDefList":true,
"content":"2010-12-29 00:00:00.0"
},
"searchContext":"ALL",
"includeCurrent":false,
"useField":false,
"fieldDisplayName":"Order Date",
"fieldEntityInfo":{
"dimName":"Date Hierarchy",
"qualifiedName":"",
"type":"ATTRIBUTE",
"isPartOfPreDefinedHierarchy":false
},
"relation":"AND",
"useFieldType":"VALUE",
"isAppliedOnDisplayField":true,
"delimiter":"^`~",
"secondValue":{
"isFromPreDefList":true,
"content":"2011-08-01 00:00:00.0"
},
"valueType":"predefined",
"id":"Sf17793478103095127060081187812428",
"nonVisual":false,
"firstDisplayValue":"2010/12/29",
"suspend":false,
"displayValueDateFormat":"yyyy/MM/dd",
"isParameter":false,
"topNField":"",
"valueBy":"VALUE",
"dataType":"DATE",
"topNDisplayValue":"",
"endEnclosure":"",
"isSearchFilter":false,
"sortOrder":"ASC",
"startEnclosure":"",
"filterType":"QUICK",
"showInDataCard":false,
"secondDisplayValue":"2011/08/01",
"operation":"BETWEEN",
"fieldType":"DIMENSION",
"isIncludedForContextSearch":true
}
],
"showDimensionFilter":true,
"showMeasureFilter":true,
"showParameterFilter":false,
"allowFilterSuspension":true
},
"useMdxFlow":true,
"shelves":[
],
"cubeObject":{
"name":"AdventureWorksMF_ValueBased_WB",
"id":"17748606041027127068053132989717",
"folderName":"Kyvos_NoSpark"
},
"showContextualFilter":true,
"view":"",
"allSlidersDirty":false,
"keyInsightsProp":"null",
"crosstabProperties":{
"isHeatmap":false,
"columnDrillMode":"MEMBER_EXPANSION",
"respChunkMode":"AUTOMATIC",
"highlightedRowDimPos":"",
"rowDrillMode":"MEMBER_EXPANSION",
"useMdxFlow":true,
"isShowTotal":false,
"showExpandCollapse":true,
"respChunkSize":"1000",
"maxRow":"10000",
"isPersistExpansion":true,
"repeatMemberValues":false,
"isShowTotalAtTop":false,
"isColClassicExpansion":false,
"showTotalType":"ALL",
"showTotalAxis":"BOTH",
"maxColumn":"1000",
"isAllHidden":true,
"highlightAlternateRows":true,
"isRowClassicExpansion":false
},
"isNameBasedId":false,
"showDimensionFilter":true,
"entityDetails":{
"entityName":"163D538F-66BB-990E-B1A3-E3BF55F0C0E1"
},
"isAllowEditing":true,
"showMeasureFilter":true,
"includeActionFilterToFetchRelevantValues":true,
"cubeVersionInfo":{
"oid":"null",
"memSep":"null",
"version":"null"
},
"contentType":"VISUALIZATION",
"isSelectedMemberValid":false,
"viewDataAs":""
}
}
}
},
"folderId":"",
"designSource":"DESIGNER",
"ownerAppName":"admin",
"common":{
"compatibilityVersion":"1",
"desc":"Thanks",
"tags":""
},
"entityState":"",
"name":"Shortcut 100",
"isPublic":true,
"subType":"",
"repositDate":"05/21/2026 17:54:48 IST",
"id":"Shortcut1779366288147361459200",
"folderName":"",
"accessRights":"1",
"categoryId":""
}
}