Validate Dataset
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API performs validation on a Dataset object, verifying its structure to ensure correctness.
Method: POST
Request URL: {kyvos-url}/rest/v2/datasets/{name-or-id}/validate
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 | Name or ID of the Dataset to be validated. Note: If the Dataset name is provided, then folderName 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 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. | – |
Request Body
Parameter Name | Type | Description | Possible Values |
|---|---|---|---|
folderName | String | Name of the folder containing the Dataset to be validated. If the Dataset is in the root directory, specify [Root]. Note: If folderName is not provided, the Dataset will be treated as a root-level entity by default. | – |
json | String | JSON configuration of the Dataset to be validated. Note: An example JSON is provided under the Resources section. | – |
Responses
200 Success (Valid Dataset)
{
"code": 0,
"message": "Dataset validated successfully.",
"validationStatus": "VALID"
}200 Success (Invalid Dataset)
{
"code": 0,
"message": "Dataset validated successfully.",
"validationStatus": "INVALID",
"validationResult": {
"name": "Orders Date",
"subType": "REGISTERED",
"id": "626F947A-FE21-80D5-38C1-5AB25F9058A5",
"hasError": true,
"type": "QUERY",
"problems": [
{
"problemFunctionalType": "DEFAULT",
"objects": [
{
"name": "Fetch",
"id": "17768385342638080860",
"type": "FETCH"
}
],
"stackTrace": {
"reason": [
{
"isExists": true,
"isEncoded": false,
"name": "Fetch",
"id": "17768385342638080860",
"type": "FETCH",
"message": "Error while connecting with JDBC driver - null",
"object": "CURRENT"
},
{
"isExists": true,
"isEncoded": false,
"name": "Fetch",
"id": "17768385342638080860",
"type": "FETCH",
"message": "Error while connecting with JDBC driver - null",
"object": "CURRENT"
}
]
},
"type": "ERROR",
"message": "Dataset is invalid"
}
]
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching Dataset found. |
500 | Internal Server Error. |
Resources
JSON Examples for request body parameter and use cases.