Chilkat Online Tools

phpExt / Commercetools / AddFieldDefinition

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.

// {
//   "version": "{{version}}",
//   "actions": [
//     {
//       "action": "addFieldDefinition",
//       "fieldDefinition": {
//         "type": {
//           "name": "LocalizedString"
//         },
//         "name": "fieldDefinitionName",
//         "label": {
//           "de": "labelDE",
//           "en": "labelEN"
//         },
//         "required": false,
//         "inputHint": "MultiLine"
//       }
//     }
//   ]
// }

$json = new CkJsonObject();
$json->UpdateString('version','{{version}}');
$json->UpdateString('actions[0].action','addFieldDefinition');
$json->UpdateString('actions[0].fieldDefinition.type.name','LocalizedString');
$json->UpdateString('actions[0].fieldDefinition.name','fieldDefinitionName');
$json->UpdateString('actions[0].fieldDefinition.label.de','labelDE');
$json->UpdateString('actions[0].fieldDefinition.label.en','labelEN');
$json->UpdateBool('actions[0].fieldDefinition.required',false);
$json->UpdateString('actions[0].fieldDefinition.inputHint','MultiLine');

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');
$http->SetRequestHeader('Content-Type','application/json');

$sbRequestBody = new CkStringBuilder();
$json->EmitSb($sbRequestBody);

// resp is a CkHttpResponse
$resp = $http->PTextSb('post','https://domain.com/{{project-key}}/types/{{type-id}}',$sbRequestBody,'utf-8','application/json',false,false);
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 "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
    "version": {{type-version}},
    "actions": [
        {
            "action" : "addFieldDefinition",
            "fieldDefinition" : {
              "type" : {
                "name" : "LocalizedString"
              },
              "name" : "fieldDefinitionName",
              "label" : {
                "de" : "labelDE",
                "en" : "labelEN"
              },
              "required" : false,
              "inputHint" : "MultiLine"
            }
          }
    ]
}'
https://domain.com/{{project-key}}/types/{{type-id}}

Postman Collection Item JSON

{
  "name": "AddFieldDefinition",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "tests[\"Status code \" + responseCode.code] = responseCode.code === 200 || responseCode.code === 201;",
          "var data = JSON.parse(responseBody);",
          "if(data.results && data.results[0] && data.results[0].id && data.results[0].version){",
          "    pm.environment.set(\"type-id\", data.results[0].id); ",
          "    pm.environment.set(\"type-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"type-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"type-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"type-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"type-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "post",
    "body": {
      "mode": "raw",
      "raw": "{\n    \"version\": {{type-version}},\n    \"actions\": [\n        {\n            \"action\" : \"addFieldDefinition\",\n            \"fieldDefinition\" : {\n              \"type\" : {\n                \"name\" : \"LocalizedString\"\n              },\n              \"name\" : \"fieldDefinitionName\",\n              \"label\" : {\n                \"de\" : \"labelDE\",\n                \"en\" : \"labelEN\"\n              },\n              \"required\" : false,\n              \"inputHint\" : \"MultiLine\"\n            }\n          }\n    ]\n}"
    },
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/types/{{type-id}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "types",
        "{{type-id}}"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "post Types"
  },
  "response": [
  ]
}