1Get Dataset Column Details
Overview
This API fetches information about the columns in a Dataset.
Method: GET
Request URL: {kyvos-url}/rest/v2/datasets/{name-or-id}/column-details
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 whose column details need 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 whose column details need to be retrieved. If the Dataset is 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 whose column details need to be retrieved. | – |
Responses
200 Success
{
"colHeader": {
"column": [
{
"fieldFormat": "",
"pigDataType": -5,
"isAccessible": true,
"dataTypeName": "NUMBER",
"precision": 0,
"scale": 0,
"caption": "",
"fullyQualifiedName": "",
"type": "",
"originalName": "productkey",
"name": "productkey",
"originalDataTypeName": 4,
"isBinaryData": false
},
{
"fieldFormat": "",
"pigDataType": -5,
"isAccessible": true,
"dataTypeName": "NUMBER",
"precision": 0,
"scale": 0,
"caption": "",
"fullyQualifiedName": "",
"type": "",
"originalName": "orderdatekey",
"name": "orderdatekey",
"originalDataTypeName": 4,
"isBinaryData": false
},
{
"fieldFormat": "",
"pigDataType": -5,
"isAccessible": true,
"dataTypeName": "NUMBER",
"precision": 0,
"scale": 0,
"caption": "",
"fullyQualifiedName": "",
"type": "",
"originalName": "duedatekey",
"name": "duedatekey",
"originalDataTypeName": 4,
"isBinaryData": false
}
]
}
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
500 | Internal Server Error |