Chilkat Online Tools

lianja / Cognite API v1 / List tables in a database

Back to Collection Items

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

loHttp = createobject("CkHttp")

loQueryParams = createobject("CkJsonObject")
loQueryParams.UpdateInt("limit",25)

loHttp.SetRequestHeader("api-key","{{api-key}}")

loResp = loHttp.QuickRequestParams("GET","https://domain.com/api/v1/projects/{{project}}/raw/dbs/:dbName/tables",loQueryParams)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loQueryParams
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loQueryParams

Curl Command

curl -G -d "limit=25"
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/raw/dbs/:dbName/tables

Postman Collection Item JSON

{
  "id": "getTables",
  "name": "List tables in a database",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "raw",
        "dbs",
        ":dbName",
        "tables"
      ],
      "query": [
        {
          "key": "limit",
          "description": "Limit on the number of tables to be returned.",
          "value": "25",
          "disabled": true
        },
        {
          "key": "cursor",
          "description": "Cursor for paging through results.",
          "disabled": true
        }
      ],
      "variable": [
        {
          "key": "dbName",
          "description": "The name of a database to retrieve tables from.",
          "disabled": true,
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ]
  }
}