Chilkat Online Tools

SQL Server / Cognite API v1 / Synthetic query

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
    -- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int

    -- Use this online tool to generate code from sample JSON: Generate Code to Create JSON

    -- The following JSON is sent in the request body.

    -- {
    --   "items": [
    --     {
    --       "expression": "minim sunt",
    --       "start": 0,
    --       "end": "now",
    --       "limit": 262
    --     },
    --     {
    --       "expression": "et ut fugiat",
    --       "start": 0,
    --       "end": "now",
    --       "limit": 6657
    --     }
    --   ]
    -- }

    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'items[0].expression', 'minim sunt'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'items[0].start', 0
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'items[0].end', 'now'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'items[0].limit', 262
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'items[1].expression', 'et ut fugiat'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'items[1].start', 0
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'items[1].end', 'now'
    EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'items[1].limit', 6657

    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'content-type', 'application/json'
    EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'api-key', '{{api-key}}'

    DECLARE @resp int
    EXEC sp_OAMethod @http, 'PostJson3', @resp OUT, 'https://domain.com/api/v1/projects/{{project}}/timeseries/synthetic/query', 'application/json', @json
    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 @json
        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 @json


END
GO

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "expression": "minim sunt",
            "start": 0,
            "end": "now",
            "limit": 262
        },
        {
            "expression": "et ut fugiat",
            "start": 0,
            "end": "now",
            "limit": 6657
        }
    ]
}'
https://domain.com/api/v1/projects/{{project}}/timeseries/synthetic/query

Postman Collection Item JSON

{
  "id": "querySyntheticTimeseries",
  "name": "Synthetic query",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "timeseries",
        "synthetic",
        "query"
      ],
      "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": "Execute an on-the-fly synthetic query",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"expression\": \"minim sunt\",\n            \"start\": 0,\n            \"end\": \"now\",\n            \"limit\": 262\n        },\n        {\n            \"expression\": \"et ut fugiat\",\n            \"start\": 0,\n            \"end\": \"now\",\n            \"limit\": 6657\n        }\n    ]\n}"
    }
  }
}