Chilkat Online Tools

phpAx / Cognite API v1 / Filter data sets

Back to Collection Items

<?php

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

$http = new COM("Chilkat_9_5_0.Http");

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

// The following JSON is sent in the request body.

// {
//   "filter": {
//     "metadata": {},
//     "createdTime": {
//       "max": 86900022,
//       "min": 66884903
//     },
//     "lastUpdatedTime": {
//       "max": 89375182,
//       "min": 70845959
//     },
//     "externalIdPrefix": "nisi in",
//     "writeProtected": false
//   },
//   "limit": 100,
//   "cursor": "quis"
// }

$json = new COM("Chilkat_9_5_0.JsonObject");
$json->UpdateNewObject('filter.metadata');
$json->UpdateInt('filter.createdTime.max',86900022);
$json->UpdateInt('filter.createdTime.min',66884903);
$json->UpdateInt('filter.lastUpdatedTime.max',89375182);
$json->UpdateInt('filter.lastUpdatedTime.min',70845959);
$json->UpdateString('filter.externalIdPrefix','nisi in');
$json->UpdateBool('filter.writeProtected',0);
$json->UpdateInt('limit',100);
$json->UpdateString('cursor','quis');

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

// resp is a Chilkat_9_5_0.HttpResponse
$resp = $http->PostJson3('https://domain.com/api/v1/projects/{{project}}/datasets/list','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->StatusCode . "\n";
print $resp->BodyStr . "\n";


?>

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "filter": {
        "metadata": {},
        "createdTime": {
            "max": 86900022,
            "min": 66884903
        },
        "lastUpdatedTime": {
            "max": 89375182,
            "min": 70845959
        },
        "externalIdPrefix": "nisi in",
        "writeProtected": false
    },
    "limit": 100,
    "cursor": "quis"
}'
https://domain.com/api/v1/projects/{{project}}/datasets/list

Postman Collection Item JSON

{
  "id": "listDataSets",
  "name": "Filter data sets",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "datasets",
        "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": "Use advanced filtering options to find data sets.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"metadata\": {},\n        \"createdTime\": {\n            \"max\": 86900022,\n            \"min\": 66884903\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 89375182,\n            \"min\": 70845959\n        },\n        \"externalIdPrefix\": \"nisi in\",\n        \"writeProtected\": false\n    },\n    \"limit\": 100,\n    \"cursor\": \"quis\"\n}"
    }
  }
}