Chilkat Online Tools

DataFlex / Cognite API v1 / Update events

Back to Collection Items

Use ChilkatAx-win32.pkg

Procedure Test
    Handle hoHttp
    Boolean iSuccess
    Variant vJson
    Handle hoJson
    Variant vResp
    Handle hoResp
    String sTemp1
    Integer iTemp1

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

    Get Create (RefClass(cComChilkatHttp)) To hoHttp
    If (Not(IsComObjectCreated(hoHttp))) Begin
        Send CreateComObject of hoHttp
    End

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

    Get Create (RefClass(cComChilkatJsonObject)) To hoJson
    If (Not(IsComObjectCreated(hoJson))) Begin
        Send CreateComObject of hoJson
    End
    Get ComUpdateBool Of hoJson "items[0].update.externalId.setNull" False To iSuccess
    Get ComUpdateBool Of hoJson "items[0].update.dataSetId.setNull" False To iSuccess
    Get ComUpdateBool Of hoJson "items[0].update.startTime.setNull" True To iSuccess
    Get ComUpdateBool Of hoJson "items[0].update.endTime.setNull" False To iSuccess
    Get ComUpdateString Of hoJson "items[0].update.description.set" "dolor cillum velit ullamco id" To iSuccess
    Get ComUpdateNewObject Of hoJson "items[0].update.metadata.set" To iSuccess
    Get ComUpdateNewArray Of hoJson "items[0].update.assetIds.add" To iSuccess
    Get ComUpdateNewArray Of hoJson "items[0].update.assetIds.remove" To iSuccess
    Get ComUpdateBool Of hoJson "items[0].update.source.setNull" True To iSuccess
    Get ComUpdateBool Of hoJson "items[0].update.type.setNull" True To iSuccess
    Get ComUpdateString Of hoJson "items[0].update.subtype.set" "Ut Duis dolor esse" To iSuccess
    Get ComUpdateInt Of hoJson "items[0].id" 123 To iSuccess
    Get ComUpdateString Of hoJson "items[1].update.externalId.set" "aliquip sit aute" To iSuccess
    Get ComUpdateInt Of hoJson "items[1].update.dataSetId.set" -95510276 To iSuccess
    Get ComUpdateBool Of hoJson "items[1].update.startTime.setNull" False To iSuccess
    Get ComUpdateBool Of hoJson "items[1].update.endTime.setNull" False To iSuccess
    Get ComUpdateString Of hoJson "items[1].update.description.set" "in dolore aliquip dolor proident" To iSuccess
    Get ComUpdateNewObject Of hoJson "items[1].update.metadata.set" To iSuccess
    Get ComUpdateNewArray Of hoJson "items[1].update.assetIds.add" To iSuccess
    Get ComUpdateNewArray Of hoJson "items[1].update.assetIds.remove" To iSuccess
    Get ComUpdateString Of hoJson "items[1].update.source.set" "dolore nostrud" To iSuccess
    Get ComUpdateString Of hoJson "items[1].update.type.set" "ea" To iSuccess
    Get ComUpdateString Of hoJson "items[1].update.subtype.set" "aute" To iSuccess
    Get ComUpdateInt Of hoJson "items[1].id" 123 To iSuccess

    Send ComSetRequestHeader To hoHttp "content-type" "application/json"
    Send ComSetRequestHeader To hoHttp "api-key" "{{api-key}}"

    Get Create (RefClass(cComChilkatHttpResponse)) To hoResp
    If (Not(IsComObjectCreated(hoResp))) Begin
        Send CreateComObject of hoResp
    End
    Get pvComObject of hoJson to vJson
    Get pvComObject of hoResp to vResp
    Get ComHttpJson Of hoHttp "POST" "https://domain.com/api/v1/projects/{{project}}/events/update" vJson "application/json" vResp To iSuccess
    If (iSuccess = False) Begin
        Get ComLastErrorText Of hoHttp To sTemp1
        Showln sTemp1
        Procedure_Return
    End

    Get ComStatusCode Of hoResp To iTemp1
    Showln iTemp1
    Get ComBodyStr Of hoResp To sTemp1
    Showln sTemp1


End_Procedure

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