Chilkat Online Tools

VB.NET / Cognite API v1 / Filter labels

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.

' {
'   "filter": {
'     "name": "exercitation esse id",
'     "externalIdPrefix": "elit",
'     "dataSetIds": [
'       {
'         "externalId": "cillum in do"
'       },
'       {
'         "externalId": "in exercitation"
'       }
'     ]
'   },
'   "cursor": "incididunt quis ad veniam in",
'   "limit": 100
' }

Dim json As New Chilkat.JsonObject
json.UpdateString("filter.name","exercitation esse id")
json.UpdateString("filter.externalIdPrefix","elit")
json.UpdateString("filter.dataSetIds[0].externalId","cillum in do")
json.UpdateString("filter.dataSetIds[1].externalId","in exercitation")
json.UpdateString("cursor","incididunt quis ad veniam in")
json.UpdateInt("limit",100)

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/list","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 '{
    "filter": {
        "name": "exercitation esse id",
        "externalIdPrefix": "elit",
        "dataSetIds": [
            {
                "externalId": "cillum in do"
            },
            {
                "externalId": "in exercitation"
            }
        ]
    },
    "cursor": "incididunt quis ad veniam in",
    "limit": 100
}'
https://domain.com/api/v1/projects/{{project}}/labels/list

Postman Collection Item JSON

{
  "id": "listLabels",
  "name": "Filter labels",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "labels",
        "list"
      ],
      "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": "Use advanced filtering options to find label definitions.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"filter\": {\n        \"name\": \"exercitation esse id\",\n        \"externalIdPrefix\": \"elit\",\n        \"dataSetIds\": [\n            {\n                \"externalId\": \"cillum in do\"\n            },\n            {\n                \"externalId\": \"in exercitation\"\n            }\n        ]\n    },\n    \"cursor\": \"incididunt quis ad veniam in\",\n    \"limit\": 100\n}"
    }
  }
}