1Get Workbook Parameters
Overview
This API fetches parameters of the specified Workbook.
Method: GET
Request URL: {kyvos-url}/rest/v2/workbooks/{name-or-id}/parameters
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 parameters are to be fetched. 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 [Root]. 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. | – |
Responses
200 Success
{
"Parameters": [
{
"actualDisplayName": "",
"displayName": "Parameter 3",
"dataType": "CHAR",
"values": [
{
"dv": "a",
"isDefault": true,
"av": "a"
},
{
"dv": "b",
"isDefault": false,
"av": "b"
}
],
"name": "Parameter 3",
"description": "",
"control": "SINGLE_SELECT_LIST",
"id": "17798131539594127017013165928700",
"type": "CUSTOM"
},
{
"actualDisplayName": "",
"displayName": "Parameter 2",
"values": [
{
"dv": "P11",
"isDefault": true,
"av": "P11"
},
{
"dv": "P50",
"isDefault": false,
"av": "P50"
}
],
"name": "Parameter 2",
"description": "",
"id": "17798131468996127049052140255125",
"type": "MEASURE"
}
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |