Chilkat Online Tools

TCL / Cognite API v1 / Retrieve row by key

Back to Collection Items

load ./chilkat.dll

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

set http [new_CkHttp]

CkHttp_SetRequestHeader $http "api-key" "{{api-key}}"

set sbResponseBody [new_CkStringBuilder]

set success [CkHttp_QuickGetSb $http "https://domain.com/api/v1/projects/{{project}}/raw/dbs/:dbName/tables/:tableName/rows/:rowKey" $sbResponseBody]
if {$success == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkStringBuilder $sbResponseBody
    exit
}

puts "Response status code = [CkHttp_get_LastStatus $http]"
puts [CkStringBuilder_getAsString $sbResponseBody]

delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody

Curl Command

curl -X GET
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/raw/dbs/:dbName/tables/:tableName/rows/:rowKey

Postman Collection Item JSON

{
  "id": "getRow",
  "name": "Retrieve row by key",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "raw",
        "dbs",
        ":dbName",
        "tables",
        ":tableName",
        "rows",
        ":rowKey"
      ],
      "query": [
      ],
      "variable": [
        {
          "key": "dbName",
          "description": "Name of the database to retrieve the row from.",
          "disabled": true,
          "type": "string"
        },
        {
          "key": "tableName",
          "description": "Name of the table to retrieve the row from.",
          "disabled": true,
          "type": "string"
        },
        {
          "key": "rowKey",
          "description": "Row key of the row to retrieve.",
          "disabled": true,
          "type": "string"
        }
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ]
  }
}