Chilkat Online Tools

VB.NET / Cognite API v1 / Delete label definitions.

Back to Collection Items

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

Dim http As New Chilkat.Http
Dim success As Boolean

' 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 u"
'     },
'     {
'       "externalId": "ut cillum et ex eu"
'     }
'   ]
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("items[0].externalId","reprehenderit u")
json.UpdateString("items[1].externalId","ut cillum et ex eu")

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

Dim resp As Chilkat.HttpResponse = http.PostJson3("https://domain.com/api/v1/projects/{{project}}/labels/delete","application/json",json)
If (http.LastMethodSuccess = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Debug.WriteLine(resp.StatusCode)
Debug.WriteLine(resp.BodyStr)

Curl Command

curl -X POST
	-H "api-key: {{api-key}}"
	-H "content-type: application/json"
	-d '{
    "items": [
        {
            "externalId": "reprehenderit u"
        },
        {
            "externalId": "ut cillum et ex eu"
        }
    ]
}'
https://domain.com/api/v1/projects/{{project}}/labels/delete

Postman Collection Item JSON

{
  "id": "deleteLabels",
  "name": "Delete label definitions.",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "labels",
        "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 all the label definitions specified by their external ids. The resource items that have the corresponding label attached remain unmodified. It is up to the client to clean up the resource items from their attached labels if necessary.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"externalId\": \"reprehenderit u\"\n        },\n        {\n            \"externalId\": \"ut cillum et ex eu\"\n        }\n    ]\n}"
    }
  }
}