Chilkat Online Tools

PureBasic / Cognite API v1 / Search time series

Back to Collection Items

IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"

Procedure ChilkatExample()

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

    http.i = CkHttp::ckCreate()
    If http.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    success.i

    ; 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": "dolor eiusmod nostrud ea cillum",
    ;     "unit": "sint culpa voluptate",
    ;     "isString": true,
    ;     "isStep": true,
    ;     "metadata": {},
    ;     "assetIds": [
    ;       8392988761056162,
    ;       2911403766826494
    ;     ],
    ;     "assetExternalIds": [
    ;       "esse non aute",
    ;       "dolor in amet et minim"
    ;     ],
    ;     "rootAssetIds": [
    ;       4628243625090460,
    ;       3862854227867686
    ;     ],
    ;     "assetSubtreeIds": [
    ;       {
    ;         "id": 229005040467072
    ;       },
    ;       {
    ;         "externalId": "aute in elit aliquip"
    ;       }
    ;     ],
    ;     "dataSetIds": [
    ;       {
    ;         "externalId": "voluptate adipisicing ex in dolore"
    ;       },
    ;       {
    ;         "externalId": "irure laboris consectetur veniam velit"
    ;       }
    ;     ],
    ;     "externalIdPrefix": "veniam",
    ;     "createdTime": {
    ;       "max": 11556036,
    ;       "min": 65169412
    ;     },
    ;     "lastUpdatedTime": {
    ;       "max": 47360518,
    ;       "min": 36601806
    ;     }
    ;   },
    ;   "search": {
    ;     "name": "cupi",
    ;     "description": "aliqua ut mi",
    ;     "query": "in id fugiat"
    ;   },
    ;   "limit": 100
    ; }

    json.i = CkJsonObject::ckCreate()
    If json.i = 0
        Debug "Failed to create object."
        ProcedureReturn
    EndIf

    CkJsonObject::ckUpdateString(json,"filter.name","dolor eiusmod nostrud ea cillum")
    CkJsonObject::ckUpdateString(json,"filter.unit","sint culpa voluptate")
    CkJsonObject::ckUpdateBool(json,"filter.isString",1)
    CkJsonObject::ckUpdateBool(json,"filter.isStep",1)
    CkJsonObject::ckUpdateNewObject(json,"filter.metadata")
    CkJsonObject::ckUpdateInt(json,"filter.assetIds[0]",8392988761056162)
    CkJsonObject::ckUpdateInt(json,"filter.assetIds[1]",2911403766826494)
    CkJsonObject::ckUpdateString(json,"filter.assetExternalIds[0]","esse non aute")
    CkJsonObject::ckUpdateString(json,"filter.assetExternalIds[1]","dolor in amet et minim")
    CkJsonObject::ckUpdateInt(json,"filter.rootAssetIds[0]",4628243625090460)
    CkJsonObject::ckUpdateInt(json,"filter.rootAssetIds[1]",3862854227867686)
    CkJsonObject::ckUpdateInt(json,"filter.assetSubtreeIds[0].id",123)
    CkJsonObject::ckUpdateString(json,"filter.assetSubtreeIds[1].externalId","aute in elit aliquip")
    CkJsonObject::ckUpdateString(json,"filter.dataSetIds[0].externalId","voluptate adipisicing ex in dolore")
    CkJsonObject::ckUpdateString(json,"filter.dataSetIds[1].externalId","irure laboris consectetur veniam velit")
    CkJsonObject::ckUpdateString(json,"filter.externalIdPrefix","veniam")
    CkJsonObject::ckUpdateInt(json,"filter.createdTime.max",11556036)
    CkJsonObject::ckUpdateInt(json,"filter.createdTime.min",65169412)
    CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.max",47360518)
    CkJsonObject::ckUpdateInt(json,"filter.lastUpdatedTime.min",36601806)
    CkJsonObject::ckUpdateString(json,"search.name","cupi")
    CkJsonObject::ckUpdateString(json,"search.description","aliqua ut mi")
    CkJsonObject::ckUpdateString(json,"search.query","in id fugiat")
    CkJsonObject::ckUpdateInt(json,"limit",100)

    CkHttp::ckSetRequestHeader(http,"content-type","application/json")
    CkHttp::ckSetRequestHeader(http,"api-key","{{api-key}}")

    resp.i = CkHttp::ckPostJson3(http,"https://domain.com/api/v1/projects/{{project}}/timeseries/search","application/json",json)
    If CkHttp::ckLastMethodSuccess(http) = 0
        Debug CkHttp::ckLastErrorText(http)
        CkHttp::ckDispose(http)
        CkJsonObject::ckDispose(json)
        ProcedureReturn
    EndIf

    Debug Str(CkHttpResponse::ckStatusCode(resp))
    Debug CkHttpResponse::ckBodyStr(resp)
    CkHttpResponse::ckDispose(resp)



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(json)


    ProcedureReturn
EndProcedure

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "filter": {
        "name": "dolor eiusmod nostrud ea cillum",
        "unit": "sint culpa voluptate",
        "isString": true,
        "isStep": true,
        "metadata": {},
        "assetIds": [
            8392988761056162,
            2911403766826494
        ],
        "assetExternalIds": [
            "esse non aute",
            "dolor in amet et minim"
        ],
        "rootAssetIds": [
            4628243625090460,
            3862854227867686
        ],
        "assetSubtreeIds": [
            {
                "id": 229005040467072
            },
            {
                "externalId": "aute in elit aliquip"
            }
        ],
        "dataSetIds": [
            {
                "externalId": "voluptate adipisicing ex in dolore"
            },
            {
                "externalId": "irure laboris consectetur veniam velit"
            }
        ],
        "externalIdPrefix": "veniam",
        "createdTime": {
            "max": 11556036,
            "min": 65169412
        },
        "lastUpdatedTime": {
            "max": 47360518,
            "min": 36601806
        }
    },
    "search": {
        "name": "cupi",
        "description": "aliqua ut mi",
        "query": "in id fugiat"
    },
    "limit": 100
}'
https://domain.com/api/v1/projects/{{project}}/timeseries/search

Postman Collection Item JSON

{
  "id": "searchTimeSeries",
  "name": "Search time series",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "timeseries",
        "search"
      ],
      "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": "Fulltext search for time series based on result relevance. Primarily meant\nfor human-centric use-cases, not for programs, since matching and\nordering may change over time. Additional filters can also be\nspecified. This operation does not support pagination.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"dolor eiusmod nostrud ea cillum\",\n        \"unit\": \"sint culpa voluptate\",\n        \"isString\": true,\n        \"isStep\": true,\n        \"metadata\": {},\n        \"assetIds\": [\n            8392988761056162,\n            2911403766826494\n        ],\n        \"assetExternalIds\": [\n            \"esse non aute\",\n            \"dolor in amet et minim\"\n        ],\n        \"rootAssetIds\": [\n            4628243625090460,\n            3862854227867686\n        ],\n        \"assetSubtreeIds\": [\n            {\n                \"id\": 229005040467072\n            },\n            {\n                \"externalId\": \"aute in elit aliquip\"\n            }\n        ],\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"voluptate adipisicing ex in dolore\"\n            },\n            {\n                \"externalId\": \"irure laboris consectetur veniam velit\"\n            }\n        ],\n        \"externalIdPrefix\": \"veniam\",\n        \"createdTime\": {\n            \"max\": 11556036,\n            \"min\": 65169412\n        },\n        \"lastUpdatedTime\": {\n            \"max\": 47360518,\n            \"min\": 36601806\n        }\n    },\n    \"search\": {\n        \"name\": \"cupi\",\n        \"description\": \"aliqua ut mi\",\n        \"query\": \"in id fugiat\"\n    },\n    \"limit\": 100\n}"
    }
  }
}