Chilkat Online Tools

TCL / Cognite API v1 / Filter 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": "consectetur reprehenderit",
#     "unit": "voluptate occaecat ut dolor ",
#     "isString": true,
#     "isStep": false,
#     "metadata": {},
#     "assetIds": [
#       2509118978120224,
#       7226404981552392
#     ],
#     "assetExternalIds": [
#       "est laborum",
#       "in in et aliquip"
#     ],
#     "rootAssetIds": [
#       6708483845679534,
#       3834273847268414
#     ],
#     "assetSubtreeIds": [
#       {
#         "id": 4838322974326730
#       },
#       {
#         "externalId": "nisi Excepteur exercitation nulla reprehenderit"
#       }
#     ],
#     "dataSetIds": [
#       {
#         "externalId": "Ut ex consectetur"
#       },
#       {
#         "id": 8956424920459844
#       }
#     ],
#     "externalIdPrefix": "reprehenderit fugiat pariatur id culpa",
#     "createdTime": {
#       "max": 82460819,
#       "min": 76400255
#     },
#     "lastUpdatedTime": {
#       "max": 24839160,
#       "min": 94565958
#     }
#   },
#   "limit": 100,
#   "cursor": "pariatur quis eu anim",
#   "partition": "do amet consectetur ad f"
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "filter.name" "consectetur reprehenderit"
CkJsonObject_UpdateString $json "filter.unit" "voluptate occaecat ut dolor "
CkJsonObject_UpdateBool $json "filter.isString" 1
CkJsonObject_UpdateBool $json "filter.isStep" 0
CkJsonObject_UpdateNewObject $json "filter.metadata"
CkJsonObject_UpdateInt $json "filter.assetIds[0]" 2509118978120224
CkJsonObject_UpdateInt $json "filter.assetIds[1]" 7226404981552392
CkJsonObject_UpdateString $json "filter.assetExternalIds[0]" "est laborum"
CkJsonObject_UpdateString $json "filter.assetExternalIds[1]" "in in et aliquip"
CkJsonObject_UpdateInt $json "filter.rootAssetIds[0]" 6708483845679534
CkJsonObject_UpdateInt $json "filter.rootAssetIds[1]" 3834273847268414
CkJsonObject_UpdateInt $json "filter.assetSubtreeIds[0].id" 123
CkJsonObject_UpdateString $json "filter.assetSubtreeIds[1].externalId" "nisi Excepteur exercitation nulla reprehenderit"
CkJsonObject_UpdateString $json "filter.dataSetIds[0].externalId" "Ut ex consectetur"
CkJsonObject_UpdateInt $json "filter.dataSetIds[1].id" 123
CkJsonObject_UpdateString $json "filter.externalIdPrefix" "reprehenderit fugiat pariatur id culpa"
CkJsonObject_UpdateInt $json "filter.createdTime.max" 82460819
CkJsonObject_UpdateInt $json "filter.createdTime.min" 76400255
CkJsonObject_UpdateInt $json "filter.lastUpdatedTime.max" 24839160
CkJsonObject_UpdateInt $json "filter.lastUpdatedTime.min" 94565958
CkJsonObject_UpdateInt $json "limit" 100
CkJsonObject_UpdateString $json "cursor" "pariatur quis eu anim"
CkJsonObject_UpdateString $json "partition" "do amet consectetur ad f"

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/list" "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": "consectetur reprehenderit",
        "unit": "voluptate occaecat ut dolor ",
        "isString": true,
        "isStep": false,
        "metadata": {},
        "assetIds": [
            2509118978120224,
            7226404981552392
        ],
        "assetExternalIds": [
            "est laborum",
            "in in et aliquip"
        ],
        "rootAssetIds": [
            6708483845679534,
            3834273847268414
        ],
        "assetSubtreeIds": [
            {
                "id": 4838322974326730
            },
            {
                "externalId": "nisi Excepteur exercitation nulla reprehenderit"
            }
        ],
        "dataSetIds": [
            {
                "externalId": "Ut ex consectetur"
            },
            {
                "id": 8956424920459844
            }
        ],
        "externalIdPrefix": "reprehenderit fugiat pariatur id culpa",
        "createdTime": {
            "max": 82460819,
            "min": 76400255
        },
        "lastUpdatedTime": {
            "max": 24839160,
            "min": 94565958
        }
    },
    "limit": 100,
    "cursor": "pariatur quis eu anim",
    "partition": "do amet consectetur ad f"
}'
https://domain.com/api/v1/projects/{{project}}/timeseries/list

Postman Collection Item JSON

{
  "id": "listTimeSeries",
  "name": "Filter time series",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "timeseries",
        "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": "Retrieves a list of time series matching the specified criteria. This operation supports pagination by cursor. Criteria can be applied to select a subset of time series.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"consectetur reprehenderit\",\n        \"unit\": \"voluptate occaecat ut dolor \",\n        \"isString\": true,\n        \"isStep\": false,\n        \"metadata\": {},\n        \"assetIds\": [\n            2509118978120224,\n            7226404981552392\n        ],\n        \"assetExternalIds\": [\n            \"est laborum\",\n            \"in in et aliquip\"\n        ],\n        \"rootAssetIds\": [\n            6708483845679534,\n            3834273847268414\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"id\": 4838322974326730\n            },\n            {\n                \"externalId\": \"nisi Excepteur exercitation nulla reprehenderit\"\n            }\n        ],\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"Ut ex consectetur\"\n            },\n            {\n                \"id\": 8956424920459844\n            }\n        ],\n        \"externalIdPrefix\": \"reprehenderit fugiat pariatur id culpa\",\n        \"createdTime\": {\n            \"max\": 82460819,\n            \"min\": 76400255\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 24839160,\n            \"min\": 94565958\n        }\n    },\n    \"limit\": 100,\n    \"cursor\": \"pariatur quis eu anim\",\n    \"partition\": \"do amet consectetur ad f\"\n}"
    }
  }
}