Chilkat Online Tools

lianja / Cognite API v1 / Synthetic query

Back to Collection Items

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

loHttp = createobject("CkHttp")

// 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
//     }
//   ]
// }

loJson = createobject("CkJsonObject")
loJson.UpdateString("items[0].expression","minim sunt")
loJson.UpdateInt("items[0].start",0)
loJson.UpdateString("items[0].end","now")
loJson.UpdateInt("items[0].limit",262)
loJson.UpdateString("items[1].expression","et ut fugiat")
loJson.UpdateInt("items[1].start",0)
loJson.UpdateString("items[1].end","now")
loJson.UpdateInt("items[1].limit",6657)

loHttp.SetRequestHeader("content-type","application/json")
loHttp.SetRequestHeader("api-key","{{api-key}}")

loResp = loHttp.PostJson3("https://domain.com/api/v1/projects/{{project}}/timeseries/synthetic/query","application/json",loJson)
if (loHttp.LastMethodSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loJson
    return
endif

? str(loResp.StatusCode)
? loResp.BodyStr
release loResp


release loHttp
release loJson

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