Chilkat Online Tools

PureBasic / Cognite API v1 / List 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

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

    CkJsonObject::ckUpdateInt(queryParams,"limit",100)
    CkJsonObject::ckUpdateString(queryParams,"includeMetadata","true")
    CkJsonObject::ckUpdateString(queryParams,"assetIds","[363848954441724, 793045462540095, 1261042166839739]")
    CkJsonObject::ckUpdateString(queryParams,"rootAssetIds","[363848954441724, 793045462540095, 1261042166839739]")

    CkHttp::ckSetRequestHeader(http,"api-key","{{api-key}}")

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

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



    CkHttp::ckDispose(http)
    CkJsonObject::ckDispose(queryParams)


    ProcedureReturn
EndProcedure

Curl Command

curl -G -d "limit=100"
	-d "includeMetadata=true"
	-d "assetIds=%5B363848954441724,%20793045462540095,%201261042166839739%5D"
	-d "rootAssetIds=%5B363848954441724,%20793045462540095,%201261042166839739%5D"
	-H "api-key: {{api-key}}"
https://domain.com/api/v1/projects/{{project}}/timeseries

Postman Collection Item JSON

{
  "id": "getTimeSeries",
  "name": "List time series",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "timeseries"
      ],
      "query": [
        {
          "key": "limit",
          "description": "Limits the number of results to return. CDF returns a maximum of 1000 results even if you specify a higher limit.",
          "value": "100",
          "disabled": true
        },
        {
          "key": "includeMetadata",
          "description": "Whether the metadata field should be returned, or not.",
          "value": "true",
          "disabled": true
        },
        {
          "key": "cursor",
          "description": "Cursor for paging through results.",
          "disabled": true
        },
        {
          "key": "partition",
          "description": "Splits the data set into N partitions.\nYou need to follow the cursors within each partition in order to receive all the data.\nExample: 1/10\n",
          "disabled": true
        },
        {
          "key": "assetIds",
          "description": "Get the time series related to the assets. The format is a list of IDs serialized as a JSON array(int64). Takes [ 1 .. 100 ] unique items.",
          "value": "[363848954441724, 793045462540095, 1261042166839739]",
          "disabled": true
        },
        {
          "key": "rootAssetIds",
          "description": "Only include time series that have a related asset in a tree rooted at any of these root assetIds.",
          "value": "[363848954441724, 793045462540095, 1261042166839739]",
          "disabled": true
        },
        {
          "key": "externalIdPrefix",
          "description": "Filter by this (case-sensitive) prefix for the external ID.",
          "disabled": true
        }
      ],
      "variable": [
      ]
    },
    "method": "GET",
    "header": [
      {
        "key": "api-key",
        "value": "{{api-key}}",
        "description": "An admin can create API keys in the Cognite console."
      }
    ],
    "description": "List time series. Use nextCursor to paginate through the results."
  }
}