Chilkat Online Tools

Foxpro / Cognite API v1 / Retrieve events

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')

* 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": [
*     {
*       "id": 5757676095071720
*     },
*     {
*       "id": 8319152192636736
*     }
*   ],
*   "ignoreUnknownIds": false
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateInt("items[0].id",123)
loJson.UpdateInt("items[1].id",123)
loJson.UpdateBool("ignoreUnknownIds",0)

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

loResp = loHttp.PostJson3("https://domain.com/api/v1/projects/{{project}}/events/byids","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    CANCEL
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": [
        {
            "id": 5757676095071720
        },
        {
            "id": 8319152192636736
        }
    ],
    "ignoreUnknownIds": false
}'
https://domain.com/api/v1/projects/{{project}}/events/byids

Postman Collection Item JSON

{
  "id": "byIdsEvents",
  "name": "Retrieve events",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "events",
        "byids"
      ],
      "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": "Retrieves information about events in the same project. Events are returned in the same order as the ids listed in the query.\n\nA maximum of 1000 event IDs may be listed per request and all of them must be unique.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"id\": 5757676095071720\n        },\n        {\n            \"id\": 8319152192636736\n        }\n    ],\n    \"ignoreUnknownIds\": false\n}"
    }
  }
}