Chilkat Online Tools

phpExt / Cognite API v1 / Filter all events

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.

// {
//   "filter": {
//     "startTime": {
//       "max": 96423541,
//       "min": 708508
//     },
//     "endTime": {
//       "isNull": false
//     },
//     "activeAtTime": {
//       "max": 42601793,
//       "min": 6545191
//     },
//     "metadata": {},
//     "assetIds": [
//       5846331094676668,
//       3408965310215146
//     ],
//     "assetExternalIds": [
//       "deserunt aliquip Ut occaecat in",
//       "non o"
//     ],
//     "rootAssetIds": [
//       {
//         "externalId": "veniam commodo minim Duis ut"
//       },
//       {
//         "id": 2472341704760768
//       }
//     ],
//     "assetSubtreeIds": [
//       {
//         "id": 6194248735806298
//       },
//       {
//         "externalId": "adipisicing"
//       }
//     ],
//     "dataSetIds": [
//       {
//         "externalId": "commodo nisi"
//       },
//       {
//         "id": 4778982098206896
//       }
//     ],
//     "source": "incididunt",
//     "type": "in occaecat",
//     "subtype": "dolore minim ipsum",
//     "createdTime": {
//       "max": 75538890,
//       "min": 51111895
//     },
//     "lastUpdatedTime": {
//       "max": 31243942,
//       "min": 56817666
//     },
//     "externalIdPrefix": "cillum"
//   },
//   "limit": 100,
//   "sort": [
//   ],
//   "cursor": "laborum officia ullamco e",
//   "partition": "elit velit"
// }

$json = new CkJsonObject();
$json->UpdateInt('filter.startTime.max',96423541);
$json->UpdateInt('filter.startTime.min',708508);
$json->UpdateBool('filter.endTime.isNull',false);
$json->UpdateInt('filter.activeAtTime.max',42601793);
$json->UpdateInt('filter.activeAtTime.min',6545191);
$json->UpdateNewObject('filter.metadata');
$json->UpdateInt('filter.assetIds[0]',5846331094676668);
$json->UpdateInt('filter.assetIds[1]',3408965310215146);
$json->UpdateString('filter.assetExternalIds[0]','deserunt aliquip Ut occaecat in');
$json->UpdateString('filter.assetExternalIds[1]','non o');
$json->UpdateString('filter.rootAssetIds[0].externalId','veniam commodo minim Duis ut');
$json->UpdateInt('filter.rootAssetIds[1].id',123);
$json->UpdateInt('filter.assetSubtreeIds[0].id',123);
$json->UpdateString('filter.assetSubtreeIds[1].externalId','adipisicing');
$json->UpdateString('filter.dataSetIds[0].externalId','commodo nisi');
$json->UpdateInt('filter.dataSetIds[1].id',123);
$json->UpdateString('filter.source','incididunt');
$json->UpdateString('filter.type','in occaecat');
$json->UpdateString('filter.subtype','dolore minim ipsum');
$json->UpdateInt('filter.createdTime.max',75538890);
$json->UpdateInt('filter.createdTime.min',51111895);
$json->UpdateInt('filter.lastUpdatedTime.max',31243942);
$json->UpdateInt('filter.lastUpdatedTime.min',56817666);
$json->UpdateString('filter.externalIdPrefix','cillum');
$json->UpdateInt('limit',100);
$json->UpdateNewArray('sort');
$json->UpdateString('cursor','laborum officia ullamco e');
$json->UpdateString('partition','elit velit');

$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}}/events/list','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 '{
    "filter": {
        "startTime": {
            "max": 96423541,
            "min": 708508
        },
        "endTime": {
            "isNull": false
        },
        "activeAtTime": {
            "max": 42601793,
            "min": 6545191
        },
        "metadata": {},
        "assetIds": [
            5846331094676668,
            3408965310215146
        ],
        "assetExternalIds": [
            "deserunt aliquip Ut occaecat in",
            "non o"
        ],
        "rootAssetIds": [
            {
                "externalId": "veniam commodo minim Duis ut"
            },
            {
                "id": 2472341704760768
            }
        ],
        "assetSubtreeIds": [
            {
                "id": 6194248735806298
            },
            {
                "externalId": "adipisicing"
            }
        ],
        "dataSetIds": [
            {
                "externalId": "commodo nisi"
            },
            {
                "id": 4778982098206896
            }
        ],
        "source": "incididunt",
        "type": "in occaecat",
        "subtype": "dolore minim ipsum",
        "createdTime": {
            "max": 75538890,
            "min": 51111895
        },
        "lastUpdatedTime": {
            "max": 31243942,
            "min": 56817666
        },
        "externalIdPrefix": "cillum"
    },
    "limit": 100,
    "sort": [],
    "cursor": "laborum officia ullamco e",
    "partition": "elit velit"
}'
https://domain.com/api/v1/projects/{{project}}/events/list

Postman Collection Item JSON

{
  "id": "advancedListEvents",
  "name": "Filter all events",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "events",
        "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": "Retrieve a list of all events in the same project. This operation supports pagination by cursor. Criteria can be applied to select a subset of events.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"startTime\": {\n            \"max\": 96423541,\n            \"min\": 708508\n        },\n        \"endTime\": {\n            \"isNull\": false\n        },\n        \"activeAtTime\": {\n            \"max\": 42601793,\n            \"min\": 6545191\n        },\n        \"metadata\": {},\n        \"assetIds\": [\n            5846331094676668,\n            3408965310215146\n        ],\n        \"assetExternalIds\": [\n            \"deserunt aliquip Ut occaecat in\",\n            \"non o\"\n        ],\n        \"rootAssetIds\": [\n            {\n                \"externalId\": \"veniam commodo minim Duis ut\"\n            },\n            {\n                \"id\": 2472341704760768\n            }\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"id\": 6194248735806298\n            },\n            {\n                \"externalId\": \"adipisicing\"\n            }\n        ],\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"commodo nisi\"\n            },\n            {\n                \"id\": 4778982098206896\n            }\n        ],\n        \"source\": \"incididunt\",\n        \"type\": \"in occaecat\",\n        \"subtype\": \"dolore minim ipsum\",\n        \"createdTime\": {\n            \"max\": 75538890,\n            \"min\": 51111895\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 31243942,\n            \"min\": 56817666\n        },\n        \"externalIdPrefix\": \"cillum\"\n    },\n    \"limit\": 100,\n    \"sort\": [],\n    \"cursor\": \"laborum officia ullamco e\",\n    \"partition\": \"elit velit\"\n}"
    }
  }
}