Search a connection for columns

Version 4.0.24.12

Search a connection for columns matching the specified name

Note: column_name must be a valid column name. It is not a search pattern.

Request

GET /connections/{connection_name}/search_columns
Datatype
Description
Request
HTTP Request
path
HTTP Path
Expand HTTP Path definition...
connection_name
string
Name of connection
query
HTTP Query
Expand HTTP Query definition...
column_name
string
Column name to find
fields
string
Requested fields.

Response

200: Column names matching search pattern

Datatype
Description
(array)
schema_name
string
Name of schema containing the table
table_name
string
Name of table containing the column
column_name
string
Name of column
data_type
string
Column data type

400: Bad Request

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

404: Not Found

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link

422: Validation Error

Datatype
Description
(object)
message
string
Error details
Expand ValidationErrorDetail definition...
field
string
Field with error
code
string
Error code
message
string
Error info message
documentation_url
string
Documentation link
documentation_url
string
Documentation link

429: Too Many Requests

Datatype
Description
(object)
message
string
Error details
documentation_url
string
Documentation link