Chilkat Online Tools

lianja / Cognite API v1 / Update events

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": [
//     {
//       "update": {
//         "externalId": {
//           "setNull": false
//         },
//         "dataSetId": {
//           "setNull": false
//         },
//         "startTime": {
//           "setNull": true
//         },
//         "endTime": {
//           "setNull": false
//         },
//         "description": {
//           "set": "dolor cillum velit ullamco id"
//         },
//         "metadata": {
//           "set": {}
//         },
//         "assetIds": {
//           "add": [
//           ],
//           "remove": [
//           ]
//         },
//         "source": {
//           "setNull": true
//         },
//         "type": {
//           "setNull": true
//         },
//         "subtype": {
//           "set": "Ut Duis dolor esse"
//         }
//       },
//       "id": 4891475566776272
//     },
//     {
//       "update": {
//         "externalId": {
//           "set": "aliquip sit aute"
//         },
//         "dataSetId": {
//           "set": -95510276
//         },
//         "startTime": {
//           "setNull": false
//         },
//         "endTime": {
//           "setNull": false
//         },
//         "description": {
//           "set": "in dolore aliquip dolor proident"
//         },
//         "metadata": {
//           "set": {}
//         },
//         "assetIds": {
//           "add": [
//           ],
//           "remove": [
//           ]
//         },
//         "source": {
//           "set": "dolore nostrud"
//         },
//         "type": {
//           "set": "ea"
//         },
//         "subtype": {
//           "set": "aute"
//         }
//       },
//       "id": 7760910451842418
//     }
//   ]
// }

loJson = createobject("CkJsonObject")
loJson.UpdateBool("items[0].update.externalId.setNull",.F.)
loJson.UpdateBool("items[0].update.dataSetId.setNull",.F.)
loJson.UpdateBool("items[0].update.startTime.setNull",.T.)
loJson.UpdateBool("items[0].update.endTime.setNull",.F.)
loJson.UpdateString("items[0].update.description.set","dolor cillum velit ullamco id")
loJson.UpdateNewObject("items[0].update.metadata.set")
loJson.UpdateNewArray("items[0].update.assetIds.add")
loJson.UpdateNewArray("items[0].update.assetIds.remove")
loJson.UpdateBool("items[0].update.source.setNull",.T.)
loJson.UpdateBool("items[0].update.type.setNull",.T.)
loJson.UpdateString("items[0].update.subtype.set","Ut Duis dolor esse")
loJson.UpdateInt("items[0].id",123)
loJson.UpdateString("items[1].update.externalId.set","aliquip sit aute")
loJson.UpdateInt("items[1].update.dataSetId.set",-95510276)
loJson.UpdateBool("items[1].update.startTime.setNull",.F.)
loJson.UpdateBool("items[1].update.endTime.setNull",.F.)
loJson.UpdateString("items[1].update.description.set","in dolore aliquip dolor proident")
loJson.UpdateNewObject("items[1].update.metadata.set")
loJson.UpdateNewArray("items[1].update.assetIds.add")
loJson.UpdateNewArray("items[1].update.assetIds.remove")
loJson.UpdateString("items[1].update.source.set","dolore nostrud")
loJson.UpdateString("items[1].update.type.set","ea")
loJson.UpdateString("items[1].update.subtype.set","aute")
loJson.UpdateInt("items[1].id",123)

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

loResp = loHttp.PostJson3("https://domain.com/api/v1/projects/{{project}}/events/update","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": [
        {
            "update": {
                "externalId": {
                    "setNull": false
                },
                "dataSetId": {
                    "setNull": false
                },
                "startTime": {
                    "setNull": true
                },
                "endTime": {
                    "setNull": false
                },
                "description": {
                    "set": "dolor cillum velit ullamco id"
                },
                "metadata": {
                    "set": {}
                },
                "assetIds": {
                    "add": [],
                    "remove": []
                },
                "source": {
                    "setNull": true
                },
                "type": {
                    "setNull": true
                },
                "subtype": {
                    "set": "Ut Duis dolor esse"
                }
            },
            "id": 4891475566776272
        },
        {
            "update": {
                "externalId": {
                    "set": "aliquip sit aute"
                },
                "dataSetId": {
                    "set": -95510276
                },
                "startTime": {
                    "setNull": false
                },
                "endTime": {
                    "setNull": false
                },
                "description": {
                    "set": "in dolore aliquip dolor proident"
                },
                "metadata": {
                    "set": {}
                },
                "assetIds": {
                    "add": [],
                    "remove": []
                },
                "source": {
                    "set": "dolore nostrud"
                },
                "type": {
                    "set": "ea"
                },
                "subtype": {
                    "set": "aute"
                }
            },
            "id": 7760910451842418
        }
    ]
}'
https://domain.com/api/v1/projects/{{project}}/events/update

Postman Collection Item JSON

{
  "id": "updateEvents",
  "name": "Update events",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "events",
        "update"
      ],
      "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": "Updates events in the same project. This operation supports partial updates; Fields omitted from queries will remain unchanged on objects.\n\nFor primitive fields (String, Long, Int), use 'set': 'value' to update value; use 'setNull': true to set that field to null.\n\nFor the Json Array field (e.g. assetIds), use 'set': [value1, value2] to update value; use 'add': [v1, v2] to add values to current list of values; use 'remove': [v1, v2] to remove these values from current list of values if exists.\n\nA maximum of 1000 events can be updated per request, and all of the event IDs must be unique.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"update\": {\n                \"externalId\": {\n                    \"setNull\": false\n                },\n                \"dataSetId\": {\n                    \"setNull\": false\n                },\n                \"startTime\": {\n                    \"setNull\": true\n                },\n                \"endTime\": {\n                    \"setNull\": false\n                },\n                \"description\": {\n                    \"set\": \"dolor cillum velit ullamco id\"\n                },\n                \"metadata\": {\n                    \"set\": {}\n                },\n                \"assetIds\": {\n                    \"add\": [],\n                    \"remove\": []\n                },\n                \"source\": {\n                    \"setNull\": true\n                },\n                \"type\": {\n                    \"setNull\": true\n                },\n                \"subtype\": {\n                    \"set\": \"Ut Duis dolor esse\"\n                }\n            },\n            \"id\": 4891475566776272\n        },\n        {\n            \"update\": {\n                \"externalId\": {\n                    \"set\": \"aliquip sit aute\"\n                },\n                \"dataSetId\": {\n                    \"set\": -95510276\n                },\n                \"startTime\": {\n                    \"setNull\": false\n                },\n                \"endTime\": {\n                    \"setNull\": false\n                },\n                \"description\": {\n                    \"set\": \"in dolore aliquip dolor proident\"\n                },\n                \"metadata\": {\n                    \"set\": {}\n                },\n                \"assetIds\": {\n                    \"add\": [],\n                    \"remove\": []\n                },\n                \"source\": {\n                    \"set\": \"dolore nostrud\"\n                },\n                \"type\": {\n                    \"set\": \"ea\"\n                },\n                \"subtype\": {\n                    \"set\": \"aute\"\n                }\n            },\n            \"id\": 7760910451842418\n        }\n    ]\n}"
    }
  }
}