Chilkat Online Tools

phpExt / Cognite API v1 / Create label definitions.

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$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
//     }
//   ]
// }

$json = new CkJsonObject();
$json->UpdateString('items[0].externalId','voluptate in culpa in');
$json->UpdateString('items[0].name','dolor fugiat');
$json->UpdateString('items[0].description','fugiat est pariatur');
$json->UpdateInt('items[0].dataSetId',123);
$json->UpdateString('items[1].externalId','Duis');
$json->UpdateString('items[1].name','aliqua mollit reprehenderit cillum laboris');
$json->UpdateString('items[1].description','occaecat anim enim quis Ut');
$json->UpdateInt('items[1].dataSetId',123);

$http->SetRequestHeader('content-type','application/json');
$http->SetRequestHeader('api-key','{{api-key}}');

// resp is a CkHttpResponse
$resp = $http->PostJson3('https://domain.com/api/v1/projects/{{project}}/labels','application/json',$json);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

print $resp->get_StatusCode() . "\n";
print $resp->bodyStr() . "\n";


?>

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}"
    }
  }
}