Save Dataset
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API adds or updates Dataset entities using the provided Dataset definition. Since this API performs bulk operations, you must have the appropriate privileges to import and export objects to use it.
Method: POST
Request URL: {kyvos-url}/rest/v2/datasets/bulk
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. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
json (Required) | String | Configuration containing the Dataset definition used to add or update a Dataset. It can include data source configuration, transformations, columns, layout settings, permissions, metadata, and other Dataset properties. Note: An example JSON is provided under the Resources section. | – |
Responses
200 Success
{
"res": {
"code": 0,
"entityId": 1776416930084312707209917545529,
"message": "Successfully updated dataset: Rest 1",
"extMessage": ""
}
}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
JSON Example for Save Dataset API request body object.