Chilkat Online Tools

SQL Server / Cognite API v1 / List time series

Back to Collection Items

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example assumes the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @http int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    DECLARE @queryParams int
    EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @queryParams OUT

    EXEC sp_OAMethod @queryParams, 'UpdateInt', @success OUT, 'limit', 100
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'includeMetadata', 'true'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'assetIds', '[363848954441724, 793045462540095, 1261042166839739]'
    EXEC sp_OAMethod @queryParams, 'UpdateString', @success OUT, 'rootAssetIds', '[363848954441724, 793045462540095, 1261042166839739]'

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'api-key', '{{api-key}}'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'QuickRequestParams', @resp OUT, 'GET', 'https://domain.com/api/v1/projects/{{project}}/timeseries', @queryParams
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @http
        EXEC @hr = sp_OADestroy @queryParams
        RETURN
      END

    EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
    PRINT @iTmp0
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0
    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @http
    EXEC @hr = sp_OADestroy @queryParams


END
GO

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