Chilkat Online Tools

Perl / Cognite API v1 / Aggregate time series

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

# 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": "et exercitation s",
#     "unit": "pariatur esse qui",
#     "isString": true,
#     "isStep": false,
#     "metadata": {},
#     "assetIds": [
#       2274246036570026,
#       8922483798410046
#     ],
#     "assetExternalIds": [
#       "proident Ut consequat in",
#       "elit incididunt aliqua"
#     ],
#     "rootAssetIds": [
#       7714215516056826,
#       4275780546438472
#     ],
#     "assetSubtreeIds": [
#       {
#         "id": 7555548287718054
#       },
#       {
#         "externalId": "re"
#       }
#     ],
#     "dataSetIds": [
#       {
#         "id": 5946532482497628
#       },
#       {
#         "externalId": "exercitation nisi elit"
#       }
#     ],
#     "externalIdPrefix": "aute Ut nostrud commodo in",
#     "createdTime": {
#       "max": 16041500,
#       "min": 71538919
#     },
#     "lastUpdatedTime": {
#       "max": 2438620,
#       "min": 18087967
#     }
#   }
# }

$json = chilkat::CkJsonObject->new();
$json->UpdateString("filter.name","et exercitation s");
$json->UpdateString("filter.unit","pariatur esse qui");
$json->UpdateBool("filter.isString",1);
$json->UpdateBool("filter.isStep",0);
$json->UpdateNewObject("filter.metadata");
$json->UpdateInt("filter.assetIds[0]",2274246036570026);
$json->UpdateInt("filter.assetIds[1]",8922483798410046);
$json->UpdateString("filter.assetExternalIds[0]","proident Ut consequat in");
$json->UpdateString("filter.assetExternalIds[1]","elit incididunt aliqua");
$json->UpdateInt("filter.rootAssetIds[0]",7714215516056826);
$json->UpdateInt("filter.rootAssetIds[1]",4275780546438472);
$json->UpdateInt("filter.assetSubtreeIds[0].id",123);
$json->UpdateString("filter.assetSubtreeIds[1].externalId","re");
$json->UpdateInt("filter.dataSetIds[0].id",123);
$json->UpdateString("filter.dataSetIds[1].externalId","exercitation nisi elit");
$json->UpdateString("filter.externalIdPrefix","aute Ut nostrud commodo in");
$json->UpdateInt("filter.createdTime.max",16041500);
$json->UpdateInt("filter.createdTime.min",71538919);
$json->UpdateInt("filter.lastUpdatedTime.max",2438620);
$json->UpdateInt("filter.lastUpdatedTime.min",18087967);

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

# resp is a HttpResponse
$resp = $http->PostJson3("https://domain.com/api/v1/projects/{{project}}/timeseries/aggregate","application/json",$json);
if ($http->get_LastMethodSuccess() == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

print $resp->get_StatusCode() . "\r\n";
print $resp->bodyStr() . "\r\n";

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "filter": {
        "name": "et exercitation s",
        "unit": "pariatur esse qui",
        "isString": true,
        "isStep": false,
        "metadata": {},
        "assetIds": [
            2274246036570026,
            8922483798410046
        ],
        "assetExternalIds": [
            "proident Ut consequat in",
            "elit incididunt aliqua"
        ],
        "rootAssetIds": [
            7714215516056826,
            4275780546438472
        ],
        "assetSubtreeIds": [
            {
                "id": 7555548287718054
            },
            {
                "externalId": "re"
            }
        ],
        "dataSetIds": [
            {
                "id": 5946532482497628
            },
            {
                "externalId": "exercitation nisi elit"
            }
        ],
        "externalIdPrefix": "aute Ut nostrud commodo in",
        "createdTime": {
            "max": 16041500,
            "min": 71538919
        },
        "lastUpdatedTime": {
            "max": 2438620,
            "min": 18087967
        }
    }
}'
https://domain.com/api/v1/projects/{{project}}/timeseries/aggregate

Postman Collection Item JSON

{
  "id": "aggregateTimeSeries",
  "name": "Aggregate time series",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "timeseries",
        "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 time series that match the given filter",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"et exercitation s\",\n        \"unit\": \"pariatur esse qui\",\n        \"isString\": true,\n        \"isStep\": false,\n        \"metadata\": {},\n        \"assetIds\": [\n            2274246036570026,\n            8922483798410046\n        ],\n        \"assetExternalIds\": [\n            \"proident Ut consequat in\",\n            \"elit incididunt aliqua\"\n        ],\n        \"rootAssetIds\": [\n            7714215516056826,\n            4275780546438472\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"id\": 7555548287718054\n            },\n            {\n                \"externalId\": \"re\"\n            }\n        ],\n        \"dataSetIds\": [\n            {\n                \"id\": 5946532482497628\n            },\n            {\n                \"externalId\": \"exercitation nisi elit\"\n            }\n        ],\n        \"externalIdPrefix\": \"aute Ut nostrud commodo in\",\n        \"createdTime\": {\n            \"max\": 16041500,\n            \"min\": 71538919\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 2438620,\n            \"min\": 18087967\n        }\n    }\n}"
    }
  }
}