Get Workbook Shortcut
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API retrieves the details of the specified shortcut from a Workbook.
Method: GET
Request URL: {kyvos-url}/rest/v2/workbooks/{name-or-id}/shortcut/{shortcut-name-or-id}
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 |
|---|---|---|---|
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 from which the shortcut is to be retrieved. Note: If the Workbook name is provided, then either folderName or folderId must also be provided. | – |
shortcut-name-or-id (Required) | String | Name or ID of the shortcut to retrieve. | – |
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 is treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the Workbook. | – |
shortcutBy | String | Specifies whether the shortcut-name-or-id parameter should be interpreted as a shortcut name or shortcut ID. If shortcutBy=name, provide the shortcut name in the shortcut-name-or-id parameter. If shortcutBy=id, provide the shortcut ID in the shortcut-name-or-id parameter. The default value is name. | – |
Responses
200 Success
{
"iro":{
"entityRepositDate":"1780400154381",
"ownerAppId":"17766706456041127064079194744063",
"linkedEntityId":"6BB67D66-4CDB-43C8-E19F-A6DA7BAB1ABC",
"type":"SHORTCUT",
"specific":{
"sourceEntitySubType":"SHEET",
"sourceEntityType":"WORKSHEET",
"sourceEntityId":"Sheet17793462714112127038077183683640",
"sourceEntityName":"Sheet 1",
"entity":{
"sheet":{
"olapLayout":{
"visualization":{
"vizArray":[
],
"chartType":"",
"currentView":"",
"type":""
},
"showParameterFilter":true,
"isFilterModeManual":false,
"filters":{
"filter":[
{
"isMemberValue":true,
"fieldName":"DIM_790022!!!H_760401!!!DIMENSION_LEVEL_303757",
"firstValue":{
"isQualified":true,
"content":"'2025'"
},
"searchContext":"ALL",
"includeCurrent":false,
"useField":false,
"fieldDisplayName":"Year",
"fieldEntityInfo":{
"dimName":"Inventory Date",
"hierName":"H_Inventory Date",
"qualifiedName":"",
"type":"DIMENSION",
"isPartOfPreDefinedHierarchy":true
},
"relation":"AND",
"useFieldType":"VALUE",
"isAppliedOnDisplayField":true,
"delimiter":"^`~",
"secondValue":{
"content":""
},
"valueType":"predefined",
"id":"Sf17804001353766127064050111890624",
"nonVisual":false,
"firstDisplayValue":"2025",
"suspend":false,
"isParameter":false,
"topNField":"",
"valueBy":"VALUE",
"dataType":"DATE",
"topNDisplayValue":"",
"endEnclosure":"",
"isSearchFilter":false,
"sortOrder":"ASC",
"startEnclosure":"",
"filterType":"QUICK",
"showInDataCard":false,
"secondDisplayValue":"",
"operation":"INLIST",
"fieldType":"DIMENSION",
"isIncludedForContextSearch":true
}
],
"showDimensionFilter":true,
"showMeasureFilter":true,
"showParameterFilter":false,
"allowFilterSuspension":true
},
"useMdxFlow":true,
"shelves":[
],
"cubeObject":{
"name":"SCD_Type1_MF_Final",
"id":"17784888583934127028070141932641",
"folderName":"Admin"
},
"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":"51DFDF1D-D668-C6FF-B892-5655F0EBF18F"
},
"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":"Test",
"tags":""
},
"entityState":"",
"name":"Shortcut 1",
"isPublic":true,
"subType":"",
"repositDate":"06/02/2026 17:05:54 IST",
"id":"Shortcut17804001353754127056042183267245",
"folderName":"",
"accessRights":"1",
"categoryId":""
}
}Note: The response contains the complete shortcut definition, including workbook, worksheet, filter, visualization, and layout configuration. The JSON above has been abbreviated for readability.
Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |