TCL / Cognite API v1 / Aggregate time series
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set 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": "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
# }
# }
# }
set json [new_CkJsonObject]
CkJsonObject_UpdateString $json "filter.name" "et exercitation s"
CkJsonObject_UpdateString $json "filter.unit" "pariatur esse qui"
CkJsonObject_UpdateBool $json "filter.isString" 1
CkJsonObject_UpdateBool $json "filter.isStep" 0
CkJsonObject_UpdateNewObject $json "filter.metadata"
CkJsonObject_UpdateInt $json "filter.assetIds[0]" 2274246036570026
CkJsonObject_UpdateInt $json "filter.assetIds[1]" 8922483798410046
CkJsonObject_UpdateString $json "filter.assetExternalIds[0]" "proident Ut consequat in"
CkJsonObject_UpdateString $json "filter.assetExternalIds[1]" "elit incididunt aliqua"
CkJsonObject_UpdateInt $json "filter.rootAssetIds[0]" 7714215516056826
CkJsonObject_UpdateInt $json "filter.rootAssetIds[1]" 4275780546438472
CkJsonObject_UpdateInt $json "filter.assetSubtreeIds[0].id" 123
CkJsonObject_UpdateString $json "filter.assetSubtreeIds[1].externalId" "re"
CkJsonObject_UpdateInt $json "filter.dataSetIds[0].id" 123
CkJsonObject_UpdateString $json "filter.dataSetIds[1].externalId" "exercitation nisi elit"
CkJsonObject_UpdateString $json "filter.externalIdPrefix" "aute Ut nostrud commodo in"
CkJsonObject_UpdateInt $json "filter.createdTime.max" 16041500
CkJsonObject_UpdateInt $json "filter.createdTime.min" 71538919
CkJsonObject_UpdateInt $json "filter.lastUpdatedTime.max" 2438620
CkJsonObject_UpdateInt $json "filter.lastUpdatedTime.min" 18087967
CkHttp_SetRequestHeader $http "content-type" "application/json"
CkHttp_SetRequestHeader $http "api-key" "{{api-key}}"
# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/api/v1/projects/{{project}}/timeseries/aggregate" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkJsonObject $json
exit
}
puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkJsonObject $json
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}"
}
}
}