lianja / Cognite API v1 / Filter time series
Back to Collection Items
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
loHttp = createobject("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"
// }
loJson = createobject("CkJsonObject")
loJson.UpdateString("filter.name","consectetur reprehenderit")
loJson.UpdateString("filter.unit","voluptate occaecat ut dolor ")
loJson.UpdateBool("filter.isString",.T.)
loJson.UpdateBool("filter.isStep",.F.)
loJson.UpdateNewObject("filter.metadata")
loJson.UpdateInt("filter.assetIds[0]",2509118978120224)
loJson.UpdateInt("filter.assetIds[1]",7226404981552392)
loJson.UpdateString("filter.assetExternalIds[0]","est laborum")
loJson.UpdateString("filter.assetExternalIds[1]","in in et aliquip")
loJson.UpdateInt("filter.rootAssetIds[0]",6708483845679534)
loJson.UpdateInt("filter.rootAssetIds[1]",3834273847268414)
loJson.UpdateInt("filter.assetSubtreeIds[0].id",123)
loJson.UpdateString("filter.assetSubtreeIds[1].externalId","nisi Excepteur exercitation nulla reprehenderit")
loJson.UpdateString("filter.dataSetIds[0].externalId","Ut ex consectetur")
loJson.UpdateInt("filter.dataSetIds[1].id",123)
loJson.UpdateString("filter.externalIdPrefix","reprehenderit fugiat pariatur id culpa")
loJson.UpdateInt("filter.createdTime.max",82460819)
loJson.UpdateInt("filter.createdTime.min",76400255)
loJson.UpdateInt("filter.lastUpdatedTime.max",24839160)
loJson.UpdateInt("filter.lastUpdatedTime.min",94565958)
loJson.UpdateInt("limit",100)
loJson.UpdateString("cursor","pariatur quis eu anim")
loJson.UpdateString("partition","do amet consectetur ad f")
loHttp.SetRequestHeader("content-type","application/json")
loHttp.SetRequestHeader("api-key","{{api-key}}")
loResp = loHttp.PostJson3("https://domain.com/api/v1/projects/{{project}}/timeseries/list","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
? loHttp.LastErrorText
release loHttp
release loJson
return
endif
? str(loResp.StatusCode)
? loResp.BodyStr
release loResp
release loHttp
release loJson
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}"
}
}
}
