Get Dataset
This documentation is for Kyvos 2026.6.x. To view documentation for other Kyvos versions, click here. |
|---|
Overview
This API retrieves the specified Dataset definition.
Method: GET
Request URL: {kyvos-url}/rest/v2/datasets/{name-or-id}
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 Dataset that needs to be retrieved. Note: If the Dataset name is provided, 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 a 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. 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. | – |
Responses
200 Success
{
"iro": {
"entityRepositDate": "1782127391937",
"ownerAppId": "397039469",
"linkedEntityId": "",
"modelType": "BASE",
"type": "QUERY",
"specific": {
"qo": {
"role": "DIMENSION",
"connType": "HADOOP_CLUSTER",
"cached": true,
"connName": "DefaultHadoopCluster01",
"transformation": {
"steps": [
{
"inputSteps": [],
"outputSteps": [],
"name": "Fetch",
"stepInfo": {
"fetchInfo": {
"columns": [
{
"updatedName": "monthstartdate",
"fieldFormat": {
"useDefault": "",
"content": "0"
},
"databaseTimeZone": "",
"pigDataType": 1,
"role": "",
"hidden": false,
"fieldDataFormatType": "1",
"dataSubTypeName": "",
"dataTypeName": "CHAR",
"precision": "",
"scale": "",
"locale": "",
"fullyQualifiedName": "",
"originalName": "monthstartdate",
"originalQualifiedName": "",
"sortType": "",
"sortOrder": "",
"name": "monthstartdate",
"originalDataTypeName": "12"
},
{
"updatedName": "monthno",
"fieldFormat": {
"useDefault": "",
"content": "0"
},
"databaseTimeZone": "",
"pigDataType": 1,
"role": "",
"hidden": false,
"fieldDataFormatType": "1",
"dataSubTypeName": "",
"dataTypeName": "CHAR",
"precision": "",
"scale": "",
"locale": "",
"fullyQualifiedName": "",
"originalName": "monthno",
"originalQualifiedName": "",
"sortType": "",
"sortOrder": "",
"name": "monthno",
"originalDataTypeName": "12"
},
{
"updatedName": "monthname",
"fieldFormat": {
"useDefault": "",
"content": "0"
},
"databaseTimeZone": "",
"pigDataType": 1,
"role": "",
"hidden": false,
"fieldDataFormatType": "1",
"dataSubTypeName": "",
"dataTypeName": "CHAR",
"precision": "",
"scale": "",
"locale": "",
"fullyQualifiedName": "",
"originalName": "monthname",
"originalQualifiedName": "",
"sortType": "",
"sortOrder": "",
"name": "monthname",
"originalDataTypeName": "12"
}
],
"fetch": {
"incrementalIdentifier": {
"columnName": ""
},
"connType": "PARENT",
"sparkJdbcDataPartitionColumn": {
"metadataMode": "DEFAULT",
"minValue": "",
"maxValue": "",
"numberOfRecords": "",
"numberOfPartitions": "",
"columnName": "",
"tableName": ""
},
"connName": "DefaultHadoopCluster01",
"inputType": "TABLE",
"source": "HCATALOG",
"isSorted": false,
"sourceSubType": "",
"lookupEnabled": false,
"hcatalogSource": {
"dbName": "0c627e",
"table": {
"type": "",
"content": "bmo_time"
}
}
}
}
},
"id": "17821273720413127046025129431012",
"type": "FETCH"
}
]
}
}
},
"folderId": "137623BB-A31F-5221-9F49-991C627DCF1E",
"designSource": "DESIGNER",
"ownerAppName": "admin",
"common": {
"compatibilityVersion": "1",
"desc": "",
"tags": ""
},
"entityState": "",
"name": "Account",
"isPublic": true,
"subType": "REGISTERED",
"repositDate": "06/22/2026 16:53:11 IST",
"id": "17821273720413127046025129431012",
"folderName": "Sales",
"accessRights": "1",
"categoryId": "137623BB-A31F-5221-9F49-991C627DCF1E"
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |