Chilkat Online Tools

phpExt / Cognite API v1 / Aggregate sequences

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": {
//     "name": "officia dolor qui voluptate proident",
//     "externalIdPrefix": "incididunt ipsum dolor in",
//     "metadata": {},
//     "assetIds": [
//       6755940932372078,
//       466388817751490
//     ],
//     "rootAssetIds": [
//       2996959927277534,
//       4434140000089514
//     ],
//     "assetSubtreeIds": [
//       {
//         "externalId": "ullamco irure"
//       },
//       {
//         "externalId": "enim sint occaecat pariatur"
//       }
//     ],
//     "createdTime": {
//       "max": 21259346,
//       "min": 24330159
//     },
//     "lastUpdatedTime": {
//       "max": 20522993,
//       "min": 46705874
//     },
//     "dataSetIds": [
//       {
//         "externalId": "do mollit velit eiusmod sunt"
//       },
//       {
//         "id": 5963974930141452
//       }
//     ]
//   }
// }

$json = new CkJsonObject();
$json->UpdateString('filter.name','officia dolor qui voluptate proident');
$json->UpdateString('filter.externalIdPrefix','incididunt ipsum dolor in');
$json->UpdateNewObject('filter.metadata');
$json->UpdateInt('filter.assetIds[0]',6755940932372078);
$json->UpdateInt('filter.assetIds[1]',466388817751490);
$json->UpdateInt('filter.rootAssetIds[0]',2996959927277534);
$json->UpdateInt('filter.rootAssetIds[1]',4434140000089514);
$json->UpdateString('filter.assetSubtreeIds[0].externalId','ullamco irure');
$json->UpdateString('filter.assetSubtreeIds[1].externalId','enim sint occaecat pariatur');
$json->UpdateInt('filter.createdTime.max',21259346);
$json->UpdateInt('filter.createdTime.min',24330159);
$json->UpdateInt('filter.lastUpdatedTime.max',20522993);
$json->UpdateInt('filter.lastUpdatedTime.min',46705874);
$json->UpdateString('filter.dataSetIds[0].externalId','do mollit velit eiusmod sunt');
$json->UpdateInt('filter.dataSetIds[1].id',123);

$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}}/sequences/aggregate','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": {
        "name": "officia dolor qui voluptate proident",
        "externalIdPrefix": "incididunt ipsum dolor in",
        "metadata": {},
        "assetIds": [
            6755940932372078,
            466388817751490
        ],
        "rootAssetIds": [
            2996959927277534,
            4434140000089514
        ],
        "assetSubtreeIds": [
            {
                "externalId": "ullamco irure"
            },
            {
                "externalId": "enim sint occaecat pariatur"
            }
        ],
        "createdTime": {
            "max": 21259346,
            "min": 24330159
        },
        "lastUpdatedTime": {
            "max": 20522993,
            "min": 46705874
        },
        "dataSetIds": [
            {
                "externalId": "do mollit velit eiusmod sunt"
            },
            {
                "id": 5963974930141452
            }
        ]
    }
}'
https://domain.com/api/v1/projects/{{project}}/sequences/aggregate

Postman Collection Item JSON

{
  "id": "aggregateSequences",
  "name": "Aggregate sequences",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "sequences",
        "aggregate"
      ],
      "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": "Count the number of sequences that match the given filter",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"officia dolor qui voluptate proident\",\n        \"externalIdPrefix\": \"incididunt ipsum dolor in\",\n        \"metadata\": {},\n        \"assetIds\": [\n            6755940932372078,\n            466388817751490\n        ],\n        \"rootAssetIds\": [\n            2996959927277534,\n            4434140000089514\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"externalId\": \"ullamco irure\"\n            },\n            {\n                \"externalId\": \"enim sint occaecat pariatur\"\n            }\n        ],\n        \"createdTime\": {\n            \"max\": 21259346,\n            \"min\": 24330159\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 20522993,\n            \"min\": 46705874\n        },\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"do mollit velit eiusmod sunt\"\n            },\n            {\n                \"id\": 5963974930141452\n            }\n        ]\n    }\n}"
    }
  }
}