Chilkat Online Tools

TCL / Cognite API v1 / Create label definitions.

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": "voluptate in culpa in",
#       "name": "dolor fugiat",
#       "description": "fugiat est pariatur",
#       "dataSetId": 4122069480134880
#     },
#     {
#       "externalId": "Duis",
#       "name": "aliqua mollit reprehenderit cillum laboris",
#       "description": "occaecat anim enim quis Ut",
#       "dataSetId": 1790157494961090
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateString $json "items[0].externalId" "voluptate in culpa in"
CkJsonObject_UpdateString $json "items[0].name" "dolor fugiat"
CkJsonObject_UpdateString $json "items[0].description" "fugiat est pariatur"
CkJsonObject_UpdateInt $json "items[0].dataSetId" 123
CkJsonObject_UpdateString $json "items[1].externalId" "Duis"
CkJsonObject_UpdateString $json "items[1].name" "aliqua mollit reprehenderit cillum laboris"
CkJsonObject_UpdateString $json "items[1].description" "occaecat anim enim quis Ut"
CkJsonObject_UpdateInt $json "items[1].dataSetId" 123

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}}/labels" "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": "voluptate in culpa in",
            "name": "dolor fugiat",
            "description": "fugiat est pariatur",
            "dataSetId": 4122069480134880
        },
        {
            "externalId": "Duis",
            "name": "aliqua mollit reprehenderit cillum laboris",
            "description": "occaecat anim enim quis Ut",
            "dataSetId": 1790157494961090
        }
    ]
}'
https://domain.com/api/v1/projects/{{project}}/labels

Postman Collection Item JSON

{
  "id": "createLabelDefinitions",
  "name": "Create label definitions.",
  "request": {
    "url": {
      "host": "{{baseUrl}}",
      "path": [
        "api",
        "v1",
        "projects",
        "{{project}}",
        "labels"
      ],
      "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": "Creates label definitions that can be used across different resource types. The label definitions are uniquely identified by their external id.",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"items\": [\n        {\n            \"externalId\": \"voluptate in culpa in\",\n            \"name\": \"dolor fugiat\",\n            \"description\": \"fugiat est pariatur\",\n            \"dataSetId\": 4122069480134880\n        },\n        {\n            \"externalId\": \"Duis\",\n            \"name\": \"aliqua mollit reprehenderit cillum laboris\",\n            \"description\": \"occaecat anim enim quis Ut\",\n            \"dataSetId\": 1790157494961090\n        }\n    ]\n}"
    }
  }
}