Chilkat Online Tools

phpExt / Cognite API v1 / Retrieve data sets

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$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.

// {
//   "items": [
//     {
//       "id": 6630156140321794
//     },
//     {
//       "externalId": "eu amet"
//     }
//   ],
//   "ignoreUnknownIds": false
// }

$json = new CkJsonObject();
$json->UpdateInt('items[0].id',123);
$json->UpdateString('items[1].externalId','eu amet');
$json->UpdateBool('ignoreUnknownIds',false);

$http->SetRequestHeader('content-type','application/json');
$http->SetRequestHeader('api-key','{{api-key}}');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/api/v1/projects/{{project}}/datasets/byids','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "id": 6630156140321794
        },
        {
            "externalId": "eu amet"
        }
    ],
    "ignoreUnknownIds": false
}'
https://domain.com/api/v1/projects/{{project}}/datasets/byids

Postman Collection Item JSON

{
  "id": "getDataSets",
  "name": "Retrieve data sets",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "datasets",
        "byids"
      ],
      "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": "Retrieve data sets by IDs or external IDs.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"id\": 6630156140321794\n        },\n        {\n            \"externalId\": \"eu amet\"\n        }\n    ],\n    \"ignoreUnknownIds\": false\n}"
    }
  }
}