Add Workbook Parameters
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API adds specified parameters in the Workbook.
Method: POST
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 |
|---|---|---|---|
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. | – |
Path Parameters
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
name-or-id (Required) | String | Name or ID of the Workbook where the new parameters will be added. 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 |
|---|---|---|---|
parameterJson (Required) | String | JSON string containing details of parameters to be added in the Workbook. Note: A sample JSON example is provided under the Resources section below. | – |
Responses
200 Success
{
"code": 0,
"message": "Successfully updated workbook: RestApiTesting_copy_rename"
}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 parameterJson parameter in the request body.
[
{
"id":"177981315395941270170131659287000",
"name":"Parameter 30",
"description":"",
"type":"CUSTOM",
"actualDisplayName":"",
"dataType":"CHAR",
"control":"SINGLE_SELECT_LIST",
"displayName":"Parameter 3",
"values":[
{
"av":"a",
"dv":"a",
"isDefault":true
},
{
"av":"b",
"dv":"b",
"isDefault":false
}
]
},
{
"id":"177981314689961270490521402551250",
"name":"Parameter 20",
"description":"",
"type":"MEASURE",
"actualDisplayName":"",
"displayName":"Parameter 2",
"values":[
{
"av":"P11",
"dv":"P11",
"isDefault":true
},
{
"av":"P50",
"dv":"P50",
"isDefault":false
}
]
},
{
"id":"177981313982211270180791450794970",
"name":"Parameter 10",
"description":"",
"type":"DIMENSION",
"actualDisplayName":"",
"displayName":"Parameter 1",
"values":[
{
"av":"Country",
"dv":"Country",
"isDefault":true,
"dimName":"Geo",
"hrName":"H_Geo"
},
{
"av":"State",
"dv":"State",
"isDefault":false,
"dimName":"Geo",
"hrName":"H_Geo"
},
{
"av":"Region",
"dv":"Region",
"isDefault":false,
"dimName":"Geo",
"hrName":"H_Geo"
}
]
}
]JSON Field Descriptions
Field | Type | Description | Possible Values | Example |
parameterJson | JSON Array | JSON array containing parameter objects to add to the workbook. Each object defines a new parameter with its type, control, and values. Required parameter for the add parameters API. | Array of parameter objects | [{...}, {...}] |
parameterJson[*] | JSON Object | Individual parameter definition containing name, type, control, and value configuration | Parameter object | {...} |
parameterJson[*].name | String | Unique name for the parameter. Required field. Must be unique within the workbook. | Any valid string | "StartDate" |
parameterJson[*].type | String | Type of parameter defining its source category. Determines how the parameter is processed. | "DIMENSION", "MEASURE", "CUSTOM" | "CUSTOM" |
parameterJson[*].description | String | Optional description explaining the purpose of the parameter | Free-form text | "Filter for selecting start date" |
parameterJson[*].actualDisplayName | String | Optional display name shown in the UI instead of the parameter name | Any string | "Select Start Date" |
parameterJson[*].dataType | String | Data type of the parameter. Required when type is CUSTOM. | "CHAR", "DATE", "NUMBER" | "DATE" |
parameterJson[*].control | String | UI control type for the parameter. Required when type is CUSTOM. | "INPUT", "MULTI_SELECT_LIST", "SINGLE_SELECT_LIST", "RANGE" | "INPUT" |
parameterJson[*].format | JSON Object | Date format configuration. Required when dataType is DATE. | Format object | {...} |
parameterJson[*].format.av | String | Date format string. Required when dataType is DATE. | "MM/DD/YYYY", "DD/MM/YY", "YYYY-MM-DD", "MM/DD/YYYY HH:mm:ss", "MM/DD/YYYY hh:mm:ss a", etc. | "MM/DD/YYYY" |
parameterJson[*].allowBlankValues | Boolean | Whether the parameter can have blank/empty values. Optional. | true, false | FALSE |
parameterJson[*].defaultValue | String | Default value for the parameter. Used with INPUT and RANGE controls. | Valid value matching dataType | "01/01/2024" |
parameterJson[*].minValue | String | Minimum value for RANGE control or INPUT validation. | Valid value matching dataType | "01/01/2020" |
parameterJson[*].maxValue | String | Maximum value for RANGE control or INPUT validation. | Valid value matching dataType | "12/31/2025" |
parameterJson[*].step | String | Step increment value for RANGE control (numeric only). | Numeric string | "1" |
parameterJson[*].values | JSON Array | List of predefined values for LIST controls or DIMENSION/MEASURE types. | Array of value objects | [{...}] |
parameterJson[].values[] | JSON Object | Individual value entry with actual and display values | Value object | {...} |
parameterJson[].values[].av | String | Actual value stored and used in queries | Value matching dataType | "Electronics" |
parameterJson[].values[].dv | String | Display value shown in the UI | Any string | "Electronics Category" |
parameterJson[].values[].isDefault | Boolean | Whether this value is selected by default | true, false | TRUE |