Chilkat Online Tools

PowerBuilder / Cognite API v1 / List time series

Back to Collection Items

integer li_rc
oleobject loo_Http
integer li_Success
oleobject loo_QueryParams
oleobject loo_Resp

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

loo_Http = create oleobject
li_rc = loo_Http.ConnectToNewObject("Chilkat_9_5_0.Http")
if li_rc < 0 then
    destroy loo_Http
    MessageBox("Error","Connecting to COM object failed")
    return
end if

loo_QueryParams = create oleobject
li_rc = loo_QueryParams.ConnectToNewObject("Chilkat_9_5_0.JsonObject")

loo_QueryParams.UpdateInt("limit",100)
loo_QueryParams.UpdateString("includeMetadata","true")
loo_QueryParams.UpdateString("assetIds","[363848954441724, 793045462540095, 1261042166839739]")
loo_QueryParams.UpdateString("rootAssetIds","[363848954441724, 793045462540095, 1261042166839739]")

loo_Http.SetRequestHeader("api-key","{{api-key}}")

loo_Resp = loo_Http.QuickRequestParams("GET","https://domain.com/api/v1/projects/{{project}}/timeseries",loo_QueryParams)
if loo_Http.LastMethodSuccess = 0 then
    Write-Debug loo_Http.LastErrorText
    destroy loo_Http
    destroy loo_QueryParams
    return
end if

Write-Debug string(loo_Resp.StatusCode)
Write-Debug loo_Resp.BodyStr
destroy loo_Resp


destroy loo_Http
destroy loo_QueryParams

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