Chilkat Online Tools

phpAx / Cognite API v1 / Search within events

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.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": {
//     "startTime": {
//       "max": 28954538,
//       "min": 46490486
//     },
//     "endTime": {
//       "isNull": false
//     },
//     "activeAtTime": {
//       "max": 27359549,
//       "min": 32947272
//     },
//     "metadata": {},
//     "assetIds": [
//       4883269954114660,
//       2578912121595962
//     ],
//     "assetExternalIds": [
//       "exercitation dolor do",
//       "occaecat"
//     ],
//     "rootAssetIds": [
//       {
//         "id": 491458656026080
//       },
//       {
//         "id": 1026689202395094
//       }
//     ],
//     "assetSubtreeIds": [
//       {
//         "externalId": "laborum"
//       },
//       {
//         "externalId": "velit Duis"
//       }
//     ],
//     "dataSetIds": [
//       {
//         "externalId": "ad"
//       },
//       {
//         "externalId": "culpa"
//       }
//     ],
//     "source": "deserunt ut mollit anim l",
//     "type": "sed nisi exercita",
//     "subtype": "aliqua Ut",
//     "createdTime": {
//       "max": 39562876,
//       "min": 1881975
//     },
//     "lastUpdatedTime": {
//       "max": 69566439,
//       "min": 58702695
//     },
//     "externalIdPrefix": "in Excepteur"
//   },
//   "search": {
//     "description": "proident ut"
//   },
//   "limit": 100
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateInt('filter.startTime.max',28954538);
$json->UpdateInt('filter.startTime.min',46490486);
$json->UpdateBool('filter.endTime.isNull',0);
$json->UpdateInt('filter.activeAtTime.max',27359549);
$json->UpdateInt('filter.activeAtTime.min',32947272);
$json->UpdateNewObject('filter.metadata');
$json->UpdateInt('filter.assetIds[0]',4883269954114660);
$json->UpdateInt('filter.assetIds[1]',2578912121595962);
$json->UpdateString('filter.assetExternalIds[0]','exercitation dolor do');
$json->UpdateString('filter.assetExternalIds[1]','occaecat');
$json->UpdateInt('filter.rootAssetIds[0].id',123);
$json->UpdateInt('filter.rootAssetIds[1].id',123);
$json->UpdateString('filter.assetSubtreeIds[0].externalId','laborum');
$json->UpdateString('filter.assetSubtreeIds[1].externalId','velit Duis');
$json->UpdateString('filter.dataSetIds[0].externalId','ad');
$json->UpdateString('filter.dataSetIds[1].externalId','culpa');
$json->UpdateString('filter.source','deserunt ut mollit anim l');
$json->UpdateString('filter.type','sed nisi exercita');
$json->UpdateString('filter.subtype','aliqua Ut');
$json->UpdateInt('filter.createdTime.max',39562876);
$json->UpdateInt('filter.createdTime.min',1881975);
$json->UpdateInt('filter.lastUpdatedTime.max',69566439);
$json->UpdateInt('filter.lastUpdatedTime.min',58702695);
$json->UpdateString('filter.externalIdPrefix','in Excepteur');
$json->UpdateString('search.description','proident ut');
$json->UpdateInt('limit',100);

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

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/api/v1/projects/{{project}}/events/search','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": {
        "startTime": {
            "max": 28954538,
            "min": 46490486
        },
        "endTime": {
            "isNull": false
        },
        "activeAtTime": {
            "max": 27359549,
            "min": 32947272
        },
        "metadata": {},
        "assetIds": [
            4883269954114660,
            2578912121595962
        ],
        "assetExternalIds": [
            "exercitation dolor do",
            "occaecat"
        ],
        "rootAssetIds": [
            {
                "id": 491458656026080
            },
            {
                "id": 1026689202395094
            }
        ],
        "assetSubtreeIds": [
            {
                "externalId": "laborum"
            },
            {
                "externalId": "velit Duis"
            }
        ],
        "dataSetIds": [
            {
                "externalId": "ad"
            },
            {
                "externalId": "culpa"
            }
        ],
        "source": "deserunt ut mollit anim l",
        "type": "sed nisi exercita",
        "subtype": "aliqua Ut",
        "createdTime": {
            "max": 39562876,
            "min": 1881975
        },
        "lastUpdatedTime": {
            "max": 69566439,
            "min": 58702695
        },
        "externalIdPrefix": "in Excepteur"
    },
    "search": {
        "description": "proident ut"
    },
    "limit": 100
}'
https://domain.com/api/v1/projects/{{project}}/events/search

Postman Collection Item JSON

{
  "id": "searchEvents",
  "name": "Search within events",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "events",
        "search"
      ],
      "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"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"startTime\": {\n            \"max\": 28954538,\n            \"min\": 46490486\n        },\n        \"endTime\": {\n            \"isNull\": false\n        },\n        \"activeAtTime\": {\n            \"max\": 27359549,\n            \"min\": 32947272\n        },\n        \"metadata\": {},\n        \"assetIds\": [\n            4883269954114660,\n            2578912121595962\n        ],\n        \"assetExternalIds\": [\n            \"exercitation dolor do\",\n            \"occaecat\"\n        ],\n        \"rootAssetIds\": [\n            {\n                \"id\": 491458656026080\n            },\n            {\n                \"id\": 1026689202395094\n            }\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"externalId\": \"laborum\"\n            },\n            {\n                \"externalId\": \"velit Duis\"\n            }\n        ],\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"ad\"\n            },\n            {\n                \"externalId\": \"culpa\"\n            }\n        ],\n        \"source\": \"deserunt ut mollit anim l\",\n        \"type\": \"sed nisi exercita\",\n        \"subtype\": \"aliqua Ut\",\n        \"createdTime\": {\n            \"max\": 39562876,\n            \"min\": 1881975\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 69566439,\n            \"min\": 58702695\n        },\n        \"externalIdPrefix\": \"in Excepteur\"\n    },\n    \"search\": {\n        \"description\": \"proident ut\"\n    },\n    \"limit\": 100\n}"
    }
  }
}