Chilkat Online Tools

phpExt / Cognite API v1 / Aggregate assets

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": "tempor in",
//     "parentIds": [
//       2218036985580300,
//       1325609532768832
//     ],
//     "parentExternalIds": [
//       "proident magna occaecat id",
//       "elit sint in"
//     ],
//     "rootIds": [
//       {
//         "id": 2434556236080026
//       },
//       {
//         "id": 3030224117188012
//       }
//     ],
//     "assetSubtreeIds": [
//       {
//         "id": 5500566008705236
//       },
//       {
//         "externalId": "magna pariatur ullamco aute"
//       }
//     ],
//     "dataSetIds": [
//       {
//         "externalId": "magna mollit eiusmod"
//       },
//       {
//         "externalId": "nulla tempor consectetur occaecat sit"
//       }
//     ],
//     "metadata": {},
//     "source": "quis",
//     "createdTime": {
//       "max": 51644802,
//       "min": 78848688
//     },
//     "lastUpdatedTime": {
//       "max": 42756152,
//       "min": 67449504
//     },
//     "root": false,
//     "externalIdPrefix": "aute officia sint nisi",
//     "labels": {
//       "containsAny": [
//         {
//           "externalId": "quis"
//         },
//         {
//           "externalId": "ex tempor"
//         }
//       ]
//     }
//   }
// }

$json = new CkJsonObject();
$json->UpdateString('filter.name','tempor in');
$json->UpdateInt('filter.parentIds[0]',2218036985580300);
$json->UpdateInt('filter.parentIds[1]',1325609532768832);
$json->UpdateString('filter.parentExternalIds[0]','proident magna occaecat id');
$json->UpdateString('filter.parentExternalIds[1]','elit sint in');
$json->UpdateInt('filter.rootIds[0].id',123);
$json->UpdateInt('filter.rootIds[1].id',123);
$json->UpdateInt('filter.assetSubtreeIds[0].id',123);
$json->UpdateString('filter.assetSubtreeIds[1].externalId','magna pariatur ullamco aute');
$json->UpdateString('filter.dataSetIds[0].externalId','magna mollit eiusmod');
$json->UpdateString('filter.dataSetIds[1].externalId','nulla tempor consectetur occaecat sit');
$json->UpdateNewObject('filter.metadata');
$json->UpdateString('filter.source','quis');
$json->UpdateInt('filter.createdTime.max',51644802);
$json->UpdateInt('filter.createdTime.min',78848688);
$json->UpdateInt('filter.lastUpdatedTime.max',42756152);
$json->UpdateInt('filter.lastUpdatedTime.min',67449504);
$json->UpdateBool('filter.root',false);
$json->UpdateString('filter.externalIdPrefix','aute officia sint nisi');
$json->UpdateString('filter.labels.containsAny[0].externalId','quis');
$json->UpdateString('filter.labels.containsAny[1].externalId','ex tempor');

$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}}/assets/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": "tempor in",
        "parentIds": [
            2218036985580300,
            1325609532768832
        ],
        "parentExternalIds": [
            "proident magna occaecat id",
            "elit sint in"
        ],
        "rootIds": [
            {
                "id": 2434556236080026
            },
            {
                "id": 3030224117188012
            }
        ],
        "assetSubtreeIds": [
            {
                "id": 5500566008705236
            },
            {
                "externalId": "magna pariatur ullamco aute"
            }
        ],
        "dataSetIds": [
            {
                "externalId": "magna mollit eiusmod"
            },
            {
                "externalId": "nulla tempor consectetur occaecat sit"
            }
        ],
        "metadata": {},
        "source": "quis",
        "createdTime": {
            "max": 51644802,
            "min": 78848688
        },
        "lastUpdatedTime": {
            "max": 42756152,
            "min": 67449504
        },
        "root": false,
        "externalIdPrefix": "aute officia sint nisi",
        "labels": {
            "containsAny": [
                {
                    "externalId": "quis"
                },
                {
                    "externalId": "ex tempor"
                }
            ]
        }
    }
}'
https://domain.com/api/v1/projects/{{project}}/assets/aggregate

Postman Collection Item JSON

{
  "id": "aggregateAssets",
  "name": "Aggregate assets",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "assets",
        "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": "Use advanced filtering options to agggregate assets.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"tempor in\",\n        \"parentIds\": [\n            2218036985580300,\n            1325609532768832\n        ],\n        \"parentExternalIds\": [\n            \"proident magna occaecat id\",\n            \"elit sint in\"\n        ],\n        \"rootIds\": [\n            {\n                \"id\": 2434556236080026\n            },\n            {\n                \"id\": 3030224117188012\n            }\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"id\": 5500566008705236\n            },\n            {\n                \"externalId\": \"magna pariatur ullamco aute\"\n            }\n        ],\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"magna mollit eiusmod\"\n            },\n            {\n                \"externalId\": \"nulla tempor consectetur occaecat sit\"\n            }\n        ],\n        \"metadata\": {},\n        \"source\": \"quis\",\n        \"createdTime\": {\n            \"max\": 51644802,\n            \"min\": 78848688\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 42756152,\n            \"min\": 67449504\n        },\n        \"root\": false,\n        \"externalIdPrefix\": \"aute officia sint nisi\",\n        \"labels\": {\n            \"containsAny\": [\n                {\n                    \"externalId\": \"quis\"\n                },\n                {\n                    \"externalId\": \"ex tempor\"\n                }\n            ]\n        }\n    }\n}"
    }
  }
}