Chilkat Online Tools

Swift / Commercetools / AddFieldDefinition

Back to Collection Items

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

    let http = CkoHttp()
    var success: Bool

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

    let json = CkoJsonObject()
    json.UpdateString("version", value: "{{version}}")
    json.UpdateString("actions[0].action", value: "addFieldDefinition")
    json.UpdateString("actions[0].fieldDefinition.type.name", value: "LocalizedString")
    json.UpdateString("actions[0].fieldDefinition.name", value: "fieldDefinitionName")
    json.UpdateString("actions[0].fieldDefinition.label.de", value: "labelDE")
    json.UpdateString("actions[0].fieldDefinition.label.en", value: "labelEN")
    json.UpdateBool("actions[0].fieldDefinition.required", value: false)
    json.UpdateString("actions[0].fieldDefinition.inputHint", value: "MultiLine")

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

    let sbRequestBody = CkoStringBuilder()
    json.EmitSb(sbRequestBody)

    var resp: CkoHttpResponse? = http.PTextSb("post", url: "https://domain.com/{{project-key}}/types/{{type-id}}", textData: sbRequestBody, charset: "utf-8", contentType: "application/json", md5: false, gzip: false)
    if http.LastMethodSuccess == false {
        print("\(http.LastErrorText)")
        return
    }

    print("\(resp!.StatusCode.intValue)")
    print("\(resp!.BodyStr)")
    resp = nil

}

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": [
  ]
}