Chilkat Online Tools

TCL / Cognite API v1 / Delete assets

Back to Collection Items

load ./chilkat.dll

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

set http [new_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": [
#     {
#       "externalId": "reprehenderit sint est"
#     },
#     {
#       "id": 6762536168331110
#     }
#   ],
#   "recursive": false,
#   "ignoreUnknownIds": false
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "items[0].externalId" "reprehenderit sint est"
CkJsonObject_UpdateInt $json "items[1].id" 123
CkJsonObject_UpdateBool $json "recursive" 0
CkJsonObject_UpdateBool $json "ignoreUnknownIds" 0

CkHttp_SetRequestHeader $http "content-type" "application/json"
CkHttp_SetRequestHeader $http "api-key" "{{api-key}}"

# resp is a CkHttpResponse
set resp [CkHttp_PostJson3 $http "https://domain.com/api/v1/projects/{{project}}/assets/delete" "application/json" $json]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "externalId": "reprehenderit sint est"
        },
        {
            "id": 6762536168331110
        }
    ],
    "recursive": false,
    "ignoreUnknownIds": false
}'
https://domain.com/api/v1/projects/{{project}}/assets/delete

Postman Collection Item JSON

{
  "id": "deleteAssets",
  "name": "Delete assets",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "assets",
        "delete"
      ],
      "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": "Delete assets. To delete all descendants, set recursive to true. The limit of the request does not include the number of descendants that are deleted.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"externalId\": \"reprehenderit sint est\"\n        },\n        {\n            \"id\": 6762536168331110\n        }\n    ],\n    \"recursive\": false,\n    \"ignoreUnknownIds\": false\n}"
    }
  }
}