1Get Columns List
Overview
This API retrieves the list of columns for the specified database.
Method: GET
Request URL: {kyvos-url}/rest/v2/connections/columns
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 media type of 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 data source connection and input details required to retrieve the list of Dataset columns. Note: An example JSON is provided under the Resources section below for reference. | – |
Responses
200 Success
{
"columns": [
{
"pigDataType": "-5",
"isAccessible": true,
"dataTypeName": "NUMBER",
"precision": 0,
"name": "ACCOUNTKEY",
"scale": 0,
"caption": "ACCOUNTKEY",
"subType": "long",
"originalDataTypeName": "4",
"isBinaryData": "FALSE"
},
{
"pigDataType": "-5",
"isAccessible": true,
"dataTypeName": "NUMBER",
"precision": 0,
"name": "PARENTACCOUNTKEY",
"scale": 0,
"caption": "PARENTACCOUNTKEY",
"subType": "long",
"originalDataTypeName": "4",
"isBinaryData": "FALSE"
},
{
"pigDataType": "-5",
"isAccessible": true,
"dataTypeName": "NUMBER",
"precision": 0,
"name": "ACCOUNTCODEALTERNATEKEY",
"scale": 0,
"caption": "ACCOUNTCODEALTERNATEKEY",
"subType": "long",
"originalDataTypeName": "4",
"isBinaryData": "FALSE"
}
]
}Status Code | Description |
|---|---|
401 | Authorization information is missing or invalid. |
404 | No matching record found. |
412 | Precondition failed. Required parameter missing. |
500 | Internal Server Error |
Resources
Below are examples of JSON structures which can be used as a reference for the json parameter in the request body. You can refer the JSON example based on the dataset used.
SQL-Based Database
{
"connectionName": "SnowflakeConnection",
"inputType": "SQL",
"sqlDetails": {
"sql": "Select * from ADVENTUREWORKS.TABLESCHEMA.DIMACCOUNT"
}
}Table-Based Database
{
"connectionName":"Postgres6",
"inputType":"TABLE",
"tableDetails":{
"databaseName":"dbName",
"schemaName":"public",
"tableName":"delve_folder"
}
}File-Based Database
{
"connectionName":"HadoopConnection",
"inputType":"FILE",
"fileDetails":{
"filePath":"user/AutomationFiles/TestSample/Sample1/Db.csv",
"fileType":"CSV"
}
}