Chilkat Online Tools

phpAx / Cognite API v1 / Filter assets

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": {
//     "name": "reprehenderit consequat cupidatat",
//     "parentIds": [
//       3870116243090848,
//       5438517294961442
//     ],
//     "parentExternalIds": [
//       "tempor dolore adipisicing enim magna",
//       "sed cillum aliqua irure n"
//     ],
//     "rootIds": [
//       {
//         "id": 3609316313824286
//       },
//       {
//         "externalId": "enim ut"
//       }
//     ],
//     "assetSubtreeIds": [
//       {
//         "id": 4152225494743294
//       },
//       {
//         "id": 3214092498108058
//       }
//     ],
//     "dataSetIds": [
//       {
//         "externalId": "do"
//       },
//       {
//         "id": 7983266347295368
//       }
//     ],
//     "metadata": {},
//     "source": "occaecat incididunt cupidatat",
//     "createdTime": {
//       "max": 93577224,
//       "min": 18146228
//     },
//     "lastUpdatedTime": {
//       "max": 72464336,
//       "min": 16571729
//     },
//     "root": true,
//     "externalIdPrefix": "veniam aliqua",
//     "labels": {
//       "containsAny": [
//         {
//           "externalId": "in Lorem consequat"
//         },
//         {
//           "externalId": "ut enim eu"
//         }
//       ]
//     }
//   },
//   "limit": 100,
//   "cursor": "elit laborum cillum",
//   "aggregatedProperties": [
//   ],
//   "partition": "ea"
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('filter.name','reprehenderit consequat cupidatat');
$json->UpdateInt('filter.parentIds[0]',3870116243090848);
$json->UpdateInt('filter.parentIds[1]',5438517294961442);
$json->UpdateString('filter.parentExternalIds[0]','tempor dolore adipisicing enim magna');
$json->UpdateString('filter.parentExternalIds[1]','sed cillum aliqua irure n');
$json->UpdateInt('filter.rootIds[0].id',123);
$json->UpdateString('filter.rootIds[1].externalId','enim ut');
$json->UpdateInt('filter.assetSubtreeIds[0].id',123);
$json->UpdateInt('filter.assetSubtreeIds[1].id',123);
$json->UpdateString('filter.dataSetIds[0].externalId','do');
$json->UpdateInt('filter.dataSetIds[1].id',123);
$json->UpdateNewObject('filter.metadata');
$json->UpdateString('filter.source','occaecat incididunt cupidatat');
$json->UpdateInt('filter.createdTime.max',93577224);
$json->UpdateInt('filter.createdTime.min',18146228);
$json->UpdateInt('filter.lastUpdatedTime.max',72464336);
$json->UpdateInt('filter.lastUpdatedTime.min',16571729);
$json->UpdateBool('filter.root',1);
$json->UpdateString('filter.externalIdPrefix','veniam aliqua');
$json->UpdateString('filter.labels.containsAny[0].externalId','in Lorem consequat');
$json->UpdateString('filter.labels.containsAny[1].externalId','ut enim eu');
$json->UpdateInt('limit',100);
$json->UpdateString('cursor','elit laborum cillum');
$json->UpdateNewArray('aggregatedProperties');
$json->UpdateString('partition','ea');

$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}}/assets/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": {
        "name": "reprehenderit consequat cupidatat",
        "parentIds": [
            3870116243090848,
            5438517294961442
        ],
        "parentExternalIds": [
            "tempor dolore adipisicing enim magna",
            "sed cillum aliqua irure n"
        ],
        "rootIds": [
            {
                "id": 3609316313824286
            },
            {
                "externalId": "enim ut"
            }
        ],
        "assetSubtreeIds": [
            {
                "id": 4152225494743294
            },
            {
                "id": 3214092498108058
            }
        ],
        "dataSetIds": [
            {
                "externalId": "do"
            },
            {
                "id": 7983266347295368
            }
        ],
        "metadata": {},
        "source": "occaecat incididunt cupidatat",
        "createdTime": {
            "max": 93577224,
            "min": 18146228
        },
        "lastUpdatedTime": {
            "max": 72464336,
            "min": 16571729
        },
        "root": true,
        "externalIdPrefix": "veniam aliqua",
        "labels": {
            "containsAny": [
                {
                    "externalId": "in Lorem consequat"
                },
                {
                    "externalId": "ut enim eu"
                }
            ]
        }
    },
    "limit": 100,
    "cursor": "elit laborum cillum",
    "aggregatedProperties": [],
    "partition": "ea"
}'
https://domain.com/api/v1/projects/{{project}}/assets/list

Postman Collection Item JSON

{
  "id": "listAssets",
  "name": "Filter assets",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "assets",
        "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 assets.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"reprehenderit consequat cupidatat\",\n        \"parentIds\": [\n            3870116243090848,\n            5438517294961442\n        ],\n        \"parentExternalIds\": [\n            \"tempor dolore adipisicing enim magna\",\n            \"sed cillum aliqua irure n\"\n        ],\n        \"rootIds\": [\n            {\n                \"id\": 3609316313824286\n            },\n            {\n                \"externalId\": \"enim ut\"\n            }\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"id\": 4152225494743294\n            },\n            {\n                \"id\": 3214092498108058\n            }\n        ],\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"do\"\n            },\n            {\n                \"id\": 7983266347295368\n            }\n        ],\n        \"metadata\": {},\n        \"source\": \"occaecat incididunt cupidatat\",\n        \"createdTime\": {\n            \"max\": 93577224,\n            \"min\": 18146228\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 72464336,\n            \"min\": 16571729\n        },\n        \"root\": true,\n        \"externalIdPrefix\": \"veniam aliqua\",\n        \"labels\": {\n            \"containsAny\": [\n                {\n                    \"externalId\": \"in Lorem consequat\"\n                },\n                {\n                    \"externalId\": \"ut enim eu\"\n                }\n            ]\n        }\n    },\n    \"limit\": 100,\n    \"cursor\": \"elit laborum cillum\",\n    \"aggregatedProperties\": [],\n    \"partition\": \"ea\"\n}"
    }
  }
}