Chilkat Online Tools

Ruby / Cognite API v1 / Filter time series

Back to Collection Items

require '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": "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"
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("filter.name","consectetur reprehenderit")
json.UpdateString("filter.unit","voluptate occaecat ut dolor ")
json.UpdateBool("filter.isString",true)
json.UpdateBool("filter.isStep",false)
json.UpdateNewObject("filter.metadata")
json.UpdateInt("filter.assetIds[0]",2509118978120224)
json.UpdateInt("filter.assetIds[1]",7226404981552392)
json.UpdateString("filter.assetExternalIds[0]","est laborum")
json.UpdateString("filter.assetExternalIds[1]","in in et aliquip")
json.UpdateInt("filter.rootAssetIds[0]",6708483845679534)
json.UpdateInt("filter.rootAssetIds[1]",3834273847268414)
json.UpdateInt("filter.assetSubtreeIds[0].id",123)
json.UpdateString("filter.assetSubtreeIds[1].externalId","nisi Excepteur exercitation nulla reprehenderit")
json.UpdateString("filter.dataSetIds[0].externalId","Ut ex consectetur")
json.UpdateInt("filter.dataSetIds[1].id",123)
json.UpdateString("filter.externalIdPrefix","reprehenderit fugiat pariatur id culpa")
json.UpdateInt("filter.createdTime.max",82460819)
json.UpdateInt("filter.createdTime.min",76400255)
json.UpdateInt("filter.lastUpdatedTime.max",24839160)
json.UpdateInt("filter.lastUpdatedTime.min",94565958)
json.UpdateInt("limit",100)
json.UpdateString("cursor","pariatur quis eu anim")
json.UpdateString("partition","do amet consectetur ad f")

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}}/timeseries/list","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

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}"
    }
  }
}