List Columns

This operation returns a list of columns for a given table or view.

GET /columns

List Columns

cURL

curl --request GET \
  --url https://cloud.cdata.com/api/columns \
  --header 'Authorization: Bearer <token>'

200

{
  "results": [
    {
      "affectedRows": 123,
      "schema": [
        {
          "catalogName": "<string>",
          "columnLabel": "<string>",
          "columnName": "<string>",
          "dataType": 1,
          "dataTypeName": "<string>",
          "length": 123,
          "nullable": true,
          "ordinal": 123,
          "precision": 123,
          "scale": 123,
          "schemaName": "<string>",
          "tableName": "<string>"
        }
      ],
      "rows": [
        [
          "<unknown>"
        ]
      ]
    }
  ],
  "error": {
    "code": 0,
    "message": "<string>"
  }
}

Authorizations

Authorization · string · header · required

JWT token authentication. Include the token in the Authorization header as Bearer {token}. See Authentication for more information on creating a token.

Query Parameters

catalogName · string

Restricts results to the specified catalog.

schemaName · string

Restricts results to the specified schema.

tableName · string

Restricts results to the specified table.

columnName · string

Restricts results to the specified column.

Response

200 - application/json

OK

results · object[] | null

Show child attributes

error · object

Show child attributes