Chilkat Online Tools

PureBasic / Cognite API v1 / Retrieve rows

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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"
    ;   ]
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateInt(json,"id",123)
    CkJsonObject::ckUpdateInt(json,"start",0)
    CkJsonObject::ckUpdateInt(json,"end",-14940119)
    CkJsonObject::ckUpdateInt(json,"limit",100)
    CkJsonObject::ckUpdateString(json,"cursor","laborum")
    CkJsonObject::ckUpdateString(json,"columns[0]","voluptate esse dolor")
    CkJsonObject::ckUpdateString(json,"columns[1]","ex")

    CkHttp::ckSetRequestHeader(http,"content-type","application/json")
    CkHttp::ckSetRequestHeader(http,"api-key","{{api-key}}")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/api/v1/projects/{{project}}/sequences/data/list","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

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}"
    }
  }
}