Chilkat Online Tools

Foxpro / Commercetools / AddFieldDefinition

Back to Collection Items

LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loSbRequestBody
LOCAL loResp

* 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 CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('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": "addFieldDefinition",
*       "fieldDefinition": {
*         "type": {
*           "name": "LocalizedString"
*         },
*         "name": "fieldDefinitionName",
*         "label": {
*           "de": "labelDE",
*           "en": "labelEN"
*         },
*         "required": false,
*         "inputHint": "MultiLine"
*       }
*     }
*   ]
* }

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("version","{{version}}")
loJson.UpdateString("actions[0].action","addFieldDefinition")
loJson.UpdateString("actions[0].fieldDefinition.type.name","LocalizedString")
loJson.UpdateString("actions[0].fieldDefinition.name","fieldDefinitionName")
loJson.UpdateString("actions[0].fieldDefinition.label.de","labelDE")
loJson.UpdateString("actions[0].fieldDefinition.label.en","labelEN")
loJson.UpdateBool("actions[0].fieldDefinition.required",0)
loJson.UpdateString("actions[0].fieldDefinition.inputHint","MultiLine")

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

* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbRequestBody = CreateObject('Chilkat.StringBuilder')
loJson.EmitSb(loSbRequestBody)

loResp = loHttp.PTextSb("post","https://domain.com/{{project-key}}/types/{{type-id}}",loSbRequestBody,"utf-8","application/json",0,0)
IF (loHttp.LastMethodSuccess = 0) THEN
    ? loHttp.LastErrorText
    RELEASE loHttp
    RELEASE loJson
    RELEASE loSbRequestBody
    CANCEL
ENDIF

? STR(loResp.StatusCode)
? loResp.BodyStr
RELEASE loResp

RELEASE loHttp
RELEASE loJson
RELEASE loSbRequestBody

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