Update Dataset Parameters
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API updates the parameters in an existing Dataset.
Method: POST
Request URL: {kyvos-url}/rest/v2/datasets/{name-or-id}/user-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 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 | Represents the name or ID of the Dataset whose parameters need to be updated. Note: If the Dataset 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 Dataset name or Dataset ID. If by=name, provide the Dataset name in the name-or-id parameter. If by=id, provide the Dataset ID in the name-or-id parameter. The default value is name. | – |
folderName | String | Name of the folder containing the Dataset. If the Dataset is present in the root directory, specify [Root]. Note: If neither folderName nor folderId is provided, the Dataset will be treated as a root-level entity by default. | – |
folderId | String | ID of the folder containing the Dataset. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
userParameters (Required) | String |
Note: An example JSON is provided under the Resources section. | – |
action | String | Determines how parameters are updated in the Dataset object. | Replace – Replaces existing parameters. Merge – Merges parameters with existing values. |
Responses
200 Success
{
"code": 0,
"message": "Successfully updated dataset: sales dataset"
}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 userParameters parameter in the request body.
[
{
"name":"Parameter 1",
"description":" Description 1",
"value":"value 1"
},
{
"name":"Parameter 2",
"value":"value 2"
}
]