Chilkat Online Tools

TCL / Cognite API v1 / Run query

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]

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "query": "sin",
#   "convertToString": true,
#   "limit": 14015535,
#   "sourceLimit": -32489793,
#   "inferSchemaLimit": 97832
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "query" "sin"
CkJsonObject_UpdateBool $json "convertToString" 1
CkJsonObject_UpdateInt $json "limit" 14015535
CkJsonObject_UpdateInt $json "sourceLimit" -32489793
CkJsonObject_UpdateInt $json "inferSchemaLimit" 97832

CkHttp_SetRequestHeader $http "content-type" "application/json"
CkHttp_SetRequestHeader $http "api-key" "{{api-key}}"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/api/v1/projects/{{project}}/transformations/query/run" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "query": "sin",
    "convertToString": true,
    "limit": 14015535,
    "sourceLimit": -32489793,
    "inferSchemaLimit": 97832
}'
https://domain.com/api/v1/projects/{{project}}/transformations/query/run

Postman Collection Item JSON

{
  "id": "runPreview",
  "name": "Run query",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "transformations",
        "query",
        "run"
      ],
      "query": [
      ],
      "variable": [
      ]
    },
    "method": "POST",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      },
      {
        "key": "content-type",
        "value": "application/json"
      }
    ],
    "description": "Preview a SQL query.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"query\": \"sin\",\n    \"convertToString\": true,\n    \"limit\": 14015535,\n    \"sourceLimit\": -32489793,\n    \"inferSchemaLimit\": 97832\n}"
    }
  }
}