Chilkat Online Tools

Objective-C / Cognite API v1 / Retrieve rows

Back to Collection Items

#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>

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

CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;

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

CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateInt: @"id" value: [NSNumber numberWithInt: 123]];
[json UpdateInt: @"start" value: [NSNumber numberWithInt: 0]];
[json UpdateInt: @"end" value: [NSNumber numberWithInt: -14940119]];
[json UpdateInt: @"limit" value: [NSNumber numberWithInt: 100]];
[json UpdateString: @"cursor" value: @"laborum"];
[json UpdateString: @"columns[0]" value: @"voluptate esse dolor"];
[json UpdateString: @"columns[1]" value: @"ex"];

[http SetRequestHeader: @"content-type" value: @"application/json"];
[http SetRequestHeader: @"api-key" value: @"{{api-key}}"];

CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/api/v1/projects/{{project}}/sequences/data/list" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
    NSLog(@"%@",http.LastErrorText);
    return;
}

NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);

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