Chilkat Online Tools

TCL / Commercetools / Update Review by key

Back to Collection Items

load ./chilkat.dll

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

set 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": 1,
#   "actions": [
#     {
#       "action": "setAuthorName",
#       "authorName": "John Doe"
#     }
#   ]
# }

set json [new_CkJsonObject]

CkJsonObject_UpdateInt $json "version" 1
CkJsonObject_UpdateString $json "actions[0].action" "setAuthorName"
CkJsonObject_UpdateString $json "actions[0].authorName" "John Doe"

# Adds the "Authorization: Bearer <access_token>" header.
CkHttp_put_AuthToken $http "<access_token>"
CkHttp_SetRequestHeader $http "Content-Type" "application/json"

set sbRequestBody [new_CkStringBuilder]

CkJsonObject_EmitSb $json $sbRequestBody

# resp is a CkHttpResponse
set resp [CkHttp_PTextSb $http "post" "https://domain.com/{{project-key}}/reviews/key={{review-key}}" $sbRequestBody "utf-8" "application/json" 0 0]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
    puts [CkHttp_lastErrorText $http]
    delete_CkHttp $http
    delete_CkJsonObject $json
    delete_CkStringBuilder $sbRequestBody
    exit
}

puts [CkHttpResponse_get_StatusCode $resp]
puts [CkHttpResponse_bodyStr $resp]
delete_CkHttpResponse $resp


delete_CkHttp $http
delete_CkJsonObject $json
delete_CkStringBuilder $sbRequestBody

Curl Command

curl -X post
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: application/json"
	-d '{
  "version" : 1,
  "actions" : [ {
    "action" : "setAuthorName",
    "authorName" : "John Doe"
  } ]
}'
https://domain.com/{{project-key}}/reviews/key={{review-key}}

Postman Collection Item JSON

{
  "name": "Update Review by key",
  "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(\"review-id\", data.results[0].id); ",
          "    pm.environment.set(\"review-version\", data.results[0].version);",
          "}",
          "if(data.results && data.results[0] && data.results[0].key){",
          "    pm.environment.set(\"review-key\", data.results[0].key); ",
          "}",
          "if(data.version){",
          "    pm.environment.set(\"review-version\", data.version);",
          "}",
          "if(data.id){",
          "    pm.environment.set(\"review-id\", data.id); ",
          "}",
          "if(data.key){",
          "    pm.environment.set(\"review-key\", data.key);",
          "}",
          ""
        ]
      }
    }
  ],
  "request": {
    "auth": {
      "type": "oauth2",
      "oauth2": {
        "accessToken": "{{ctp_access_token}}",
        "addTokenTo": "header",
        "tokenType": "Bearer"
      }
    },
    "method": "post",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{host}}/{{project-key}}/reviews/key={{review-key}}",
      "host": [
        "{{host}}"
      ],
      "path": [
        "{{project-key}}",
        "reviews",
        "key={{review-key}}"
      ],
      "query": [
        {
          "key": "expand",
          "value": "",
          "equals": true,
          "disabled": true
        }
      ]
    },
    "description": "null",
    "body": {
      "mode": "raw",
      "raw": "{\n  \"version\" : 1,\n  \"actions\" : [ {\n    \"action\" : \"setAuthorName\",\n    \"authorName\" : \"John Doe\"\n  } ]\n}"
    }
  },
  "response": [
  ]
}