Chilkat Online Tools

phpAx / Commercetools / AddLocalizedEnumValue

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

// 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": "addLocalizedEnumValue",
//       "fieldName": "CustomLeNumField",
//       "value": {
//         "key": "NewLocalizedEnumKeyString",
//         "label": {
//           "en": "NewLocalizedEnumLabelEN",
//           "de": "NewLocalizedEnumLabelDE"
//         }
//       }
//     }
//   ]
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('version','{{version}}');
$json->UpdateString('actions[0].action','addLocalizedEnumValue');
$json->UpdateString('actions[0].fieldName','CustomLeNumField');
$json->UpdateString('actions[0].value.key','NewLocalizedEnumKeyString');
$json->UpdateString('actions[0].value.label.en','NewLocalizedEnumLabelEN');
$json->UpdateString('actions[0].value.label.de','NewLocalizedEnumLabelDE');

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbRequestBody = new COM("Chilkat.StringBuilder");
$json->EmitSb($sbRequestBody);

// resp is a Chilkat.HttpResponse
$resp = $http->PTextSb('post','https://domain.com/{{project-key}}/types/{{type-id}}',$sbRequestBody,'utf-8','application/json',0,0);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

print $resp->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" : "addLocalizedEnumValue",
            "fieldName" : "CustomLeNumField",
            "value" : {
              "key" : "NewLocalizedEnumKeyString",
              "label" : {
                "en" : "NewLocalizedEnumLabelEN",
                "de" : "NewLocalizedEnumLabelDE"
              }
            }
          }
    ]
}'
https://domain.com/{{project-key}}/types/{{type-id}}

Postman Collection Item JSON

{
  "name": "AddLocalizedEnumValue",
  "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\" : \"addLocalizedEnumValue\",\n            \"fieldName\" : \"CustomLeNumField\",\n            \"value\" : {\n              \"key\" : \"NewLocalizedEnumKeyString\",\n              \"label\" : {\n                \"en\" : \"NewLocalizedEnumLabelEN\",\n                \"de\" : \"NewLocalizedEnumLabelDE\"\n              }\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": [
  ]
}