Chilkat Online Tools

TCL / Cognite API v1 / Retrieve rows

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.

# {
#   "id": 1844083276579324,
#   "start": 0,
#   "end": -14940119,
#   "limit": 100,
#   "cursor": "laborum",
#   "columns": [
#     "voluptate esse dolor",
#     "ex"
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateInt $json "id" 123
CkJsonObject_UpdateInt $json "start" 0
CkJsonObject_UpdateInt $json "end" -14940119
CkJsonObject_UpdateInt $json "limit" 100
CkJsonObject_UpdateString $json "cursor" "laborum"
CkJsonObject_UpdateString $json "columns[0]" "voluptate esse dolor"
CkJsonObject_UpdateString $json "columns[1]" "ex"

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}}/sequences/data/list" "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 '{
    "id": 1844083276579324,
    "start": 0,
    "end": -14940119,
    "limit": 100,
    "cursor": "laborum",
    "columns": [
        "voluptate esse dolor",
        "ex"
    ]
}'
https://domain.com/api/v1/projects/{{project}}/sequences/data/list

Postman Collection Item JSON

{
  "id": "getSequenceData",
  "name": "Retrieve rows",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "sequences",
        "data",
        "list"
      ],
      "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": "Processes data requests, and returns the result. NB - This operation uses a dynamic limit on the number of rows returned based on the number and type of columns, use the provided cursor to paginate and retrieve all data.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"id\": 1844083276579324,\n    \"start\": 0,\n    \"end\": -14940119,\n    \"limit\": 100,\n    \"cursor\": \"laborum\",\n    \"columns\": [\n        \"voluptate esse dolor\",\n        \"ex\"\n    ]\n}"
    }
  }
}