Back to Collection Items
IncludeFile "CkJsonObject.pb"
IncludeFile "CkHttp.pb"
IncludeFile "CkHttpResponse.pb"
Procedure ChilkatExample()
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
http.i = CkHttp::ckCreate()
If http.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
; 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
; }
; ]
; }
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"items[0].update.externalId.set","ad")
CkJsonObject::ckUpdateString(json,"items[0].update.name.set","incididunt proident in")
CkJsonObject::ckUpdateBool(json,"items[0].update.description.setNull",1)
CkJsonObject::ckUpdateInt(json,"items[0].update.dataSetId.set",-49836609)
CkJsonObject::ckUpdateNewObject(json,"items[0].update.metadata.set")
CkJsonObject::ckUpdateString(json,"items[0].update.source.set","sed laboris ut")
CkJsonObject::ckUpdateInt(json,"items[0].update.parentId.set",123)
CkJsonObject::ckUpdateString(json,"items[0].update.parentExternalId.set","cupidatat")
CkJsonObject::ckUpdateString(json,"items[0].update.labels.set[0].externalId","sit anim ipsum")
CkJsonObject::ckUpdateString(json,"items[0].update.labels.set[1].externalId","fugiat cillum")
CkJsonObject::ckUpdateString(json,"items[0].externalId","deserunt ")
CkJsonObject::ckUpdateBool(json,"items[1].update.externalId.setNull",0)
CkJsonObject::ckUpdateString(json,"items[1].update.name.set","aute")
CkJsonObject::ckUpdateBool(json,"items[1].update.description.setNull",1)
CkJsonObject::ckUpdateInt(json,"items[1].update.dataSetId.set",-68427017)
CkJsonObject::ckUpdateNewObject(json,"items[1].update.metadata.add")
CkJsonObject::ckUpdateNewArray(json,"items[1].update.metadata.remove")
CkJsonObject::ckUpdateString(json,"items[1].update.source.set","incididunt proident aute consequat")
CkJsonObject::ckUpdateInt(json,"items[1].update.parentId.set",123)
CkJsonObject::ckUpdateString(json,"items[1].update.parentExternalId.set","quis est mollit esse")
CkJsonObject::ckUpdateString(json,"items[1].update.labels.add[0].externalId","officia pariatur mollit sunt")
CkJsonObject::ckUpdateString(json,"items[1].update.labels.add[1].externalId","pariatur veniam")
CkJsonObject::ckUpdateString(json,"items[1].update.labels.remove[0].externalId","dolor nulla dolor non")
CkJsonObject::ckUpdateString(json,"items[1].update.labels.remove[1].externalId","ex")
CkJsonObject::ckUpdateInt(json,"items[1].id",123)
CkHttp::ckSetRequestHeader(http,"content-type","application/json")
CkHttp::ckSetRequestHeader(http,"api-key","{{api-key}}")
resp.i = CkHttp::ckPostJson3(http,"https://domain.com/api/v1/projects/{{project}}/assets/update","application/json",json)
If CkHttp::ckLastMethodSuccess(http) = 0
Debug CkHttp::ckLastErrorText(http)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndIf
Debug Str(CkHttpResponse::ckStatusCode(resp))
Debug CkHttpResponse::ckBodyStr(resp)
CkHttpResponse::ckDispose(resp)
CkHttp::ckDispose(http)
CkJsonObject::ckDispose(json)
ProcedureReturn
EndProcedure
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}"
}
}
}