Chilkat Online Tools

Foxpro / Cognite API v1 / Update assets

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.

loHttp = CreateObject('Chilkat_9_5_0.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": [
*     {
*       "update": {
*         "externalId": {
*           "set": "ad"
*         },
*         "name": {
*           "set": "incididunt proident in"
*         },
*         "description": {
*           "setNull": true
*         },
*         "dataSetId": {
*           "set": -49836609
*         },
*         "metadata": {
*           "set": {}
*         },
*         "source": {
*           "set": "sed laboris ut"
*         },
*         "parentId": {
*           "set": 1285179828449184
*         },
*         "parentExternalId": {
*           "set": "cupidatat"
*         },
*         "labels": {
*           "set": [
*             {
*               "externalId": "sit anim ipsum"
*             },
*             {
*               "externalId": "fugiat cillum"
*             }
*           ]
*         }
*       },
*       "externalId": "deserunt "
*     },
*     {
*       "update": {
*         "externalId": {
*           "setNull": false
*         },
*         "name": {
*           "set": "aute"
*         },
*         "description": {
*           "setNull": true
*         },
*         "dataSetId": {
*           "set": -68427017
*         },
*         "metadata": {
*           "add": {},
*           "remove": [
*           ]
*         },
*         "source": {
*           "set": "incididunt proident aute consequat"
*         },
*         "parentId": {
*           "set": 4455735300348148
*         },
*         "parentExternalId": {
*           "set": "quis est mollit esse"
*         },
*         "labels": {
*           "add": [
*             {
*               "externalId": "officia pariatur mollit sunt"
*             },
*             {
*               "externalId": "pariatur veniam"
*             }
*           ],
*           "remove": [
*             {
*               "externalId": "dolor nulla dolor non"
*             },
*             {
*               "externalId": "ex"
*             }
*           ]
*         }
*       },
*       "id": 7396120406053176
*     }
*   ]
* }

loJson = CreateObject('Chilkat_9_5_0.JsonObject')
loJson.UpdateString("items[0].update.externalId.set","ad")
loJson.UpdateString("items[0].update.name.set","incididunt proident in")
loJson.UpdateBool("items[0].update.description.setNull",1)
loJson.UpdateInt("items[0].update.dataSetId.set",-49836609)
loJson.UpdateNewObject("items[0].update.metadata.set")
loJson.UpdateString("items[0].update.source.set","sed laboris ut")
loJson.UpdateInt("items[0].update.parentId.set",123)
loJson.UpdateString("items[0].update.parentExternalId.set","cupidatat")
loJson.UpdateString("items[0].update.labels.set[0].externalId","sit anim ipsum")
loJson.UpdateString("items[0].update.labels.set[1].externalId","fugiat cillum")
loJson.UpdateString("items[0].externalId","deserunt ")
loJson.UpdateBool("items[1].update.externalId.setNull",0)
loJson.UpdateString("items[1].update.name.set","aute")
loJson.UpdateBool("items[1].update.description.setNull",1)
loJson.UpdateInt("items[1].update.dataSetId.set",-68427017)
loJson.UpdateNewObject("items[1].update.metadata.add")
loJson.UpdateNewArray("items[1].update.metadata.remove")
loJson.UpdateString("items[1].update.source.set","incididunt proident aute consequat")
loJson.UpdateInt("items[1].update.parentId.set",123)
loJson.UpdateString("items[1].update.parentExternalId.set","quis est mollit esse")
loJson.UpdateString("items[1].update.labels.add[0].externalId","officia pariatur mollit sunt")
loJson.UpdateString("items[1].update.labels.add[1].externalId","pariatur veniam")
loJson.UpdateString("items[1].update.labels.remove[0].externalId","dolor nulla dolor non")
loJson.UpdateString("items[1].update.labels.remove[1].externalId","ex")
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}}/assets/update","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": [
        {
            "update": {
                "externalId": {
                    "set": "ad"
                },
                "name": {
                    "set": "incididunt proident in"
                },
                "description": {
                    "setNull": true
                },
                "dataSetId": {
                    "set": -49836609
                },
                "metadata": {
                    "set": {}
                },
                "source": {
                    "set": "sed laboris ut"
                },
                "parentId": {
                    "set": 1285179828449184
                },
                "parentExternalId": {
                    "set": "cupidatat"
                },
                "labels": {
                    "set": [
                        {
                            "externalId": "sit anim ipsum"
                        },
                        {
                            "externalId": "fugiat cillum"
                        }
                    ]
                }
            },
            "externalId": "deserunt "
        },
        {
            "update": {
                "externalId": {
                    "setNull": false
                },
                "name": {
                    "set": "aute"
                },
                "description": {
                    "setNull": true
                },
                "dataSetId": {
                    "set": -68427017
                },
                "metadata": {
                    "add": {},
                    "remove": []
                },
                "source": {
                    "set": "incididunt proident aute consequat"
                },
                "parentId": {
                    "set": 4455735300348148
                },
                "parentExternalId": {
                    "set": "quis est mollit esse"
                },
                "labels": {
                    "add": [
                        {
                            "externalId": "officia pariatur mollit sunt"
                        },
                        {
                            "externalId": "pariatur veniam"
                        }
                    ],
                    "remove": [
                        {
                            "externalId": "dolor nulla dolor non"
                        },
                        {
                            "externalId": "ex"
                        }
                    ]
                }
            },
            "id": 7396120406053176
        }
    ]
}'
https://domain.com/api/v1/projects/{{project}}/assets/update

Postman Collection Item JSON

{
  "id": "updateAssets",
  "name": "Update assets",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "assets",
        "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": "Update the attributes of assets.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"update\": {\n                \"externalId\": {\n                    \"set\": \"ad\"\n                },\n                \"name\": {\n                    \"set\": \"incididunt proident in\"\n                },\n                \"description\": {\n                    \"setNull\": true\n                },\n                \"dataSetId\": {\n                    \"set\": -49836609\n                },\n                \"metadata\": {\n                    \"set\": {}\n                },\n                \"source\": {\n                    \"set\": \"sed laboris ut\"\n                },\n                \"parentId\": {\n                    \"set\": 1285179828449184\n                },\n                \"parentExternalId\": {\n                    \"set\": \"cupidatat\"\n                },\n                \"labels\": {\n                    \"set\": [\n                        {\n                            \"externalId\": \"sit anim ipsum\"\n                        },\n                        {\n                            \"externalId\": \"fugiat cillum\"\n                        }\n                    ]\n                }\n            },\n            \"externalId\": \"deserunt \"\n        },\n        {\n            \"update\": {\n                \"externalId\": {\n                    \"setNull\": false\n                },\n                \"name\": {\n                    \"set\": \"aute\"\n                },\n                \"description\": {\n                    \"setNull\": true\n                },\n                \"dataSetId\": {\n                    \"set\": -68427017\n                },\n                \"metadata\": {\n                    \"add\": {},\n                    \"remove\": []\n                },\n                \"source\": {\n                    \"set\": \"incididunt proident aute consequat\"\n                },\n                \"parentId\": {\n                    \"set\": 4455735300348148\n                },\n                \"parentExternalId\": {\n                    \"set\": \"quis est mollit esse\"\n                },\n                \"labels\": {\n                    \"add\": [\n                        {\n                            \"externalId\": \"officia pariatur mollit sunt\"\n                        },\n                        {\n                            \"externalId\": \"pariatur veniam\"\n                        }\n                    ],\n                    \"remove\": [\n                        {\n                            \"externalId\": \"dolor nulla dolor non\"\n                        },\n                        {\n                            \"externalId\": \"ex\"\n                        }\n                    ]\n                }\n            },\n            \"id\": 7396120406053176\n        }\n    ]\n}"
    }
  }
}