Chilkat Online Tools

Ruby / EPC 2.0 - Partner Sandbox - 19.4 November [External] / [Partner] Create a Transaction Event

Back to Collection Items

require 'chilkat'

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

http = Chilkat::CkHttp.new()

# Use this online tool to generate code from sample JSON: Generate Code to Create JSON

# The following JSON is sent in the request body.

# {
#   "text": "EVENT_DESCRIPTION",
#   "type": "EVENT_TYPE",
#   "comments": "EVENT_COMMENTS",
#   "resources": [
#     {
#       "id": "{{partner_resource_id}}",
#       "name": "{{partner_resource_name}}",
#       "mimeType": "{{partner_resource_mimeType}}"
#     }
#   ]
# }

json = Chilkat::CkJsonObject.new()
json.UpdateString("text","EVENT_DESCRIPTION")
json.UpdateString("type","EVENT_TYPE")
json.UpdateString("comments","EVENT_COMMENTS")
json.UpdateString("resources[0].id","{{partner_resource_id}}")
json.UpdateString("resources[0].name","{{partner_resource_name}}")
json.UpdateString("resources[0].mimeType","{{partner_resource_mimeType}}")

# Adds the "Authorization: Bearer {{partner_token}}" header.
http.put_AuthToken("{{partner_token}}")
http.SetRequestHeader("Content-Type","application/json")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

print resp.get_StatusCode().to_s() + "\n";
print resp.bodyStr() + "\n";

Curl Command

curl -X POST
	-H "Authorization: Bearer {{partner_token}}"
	-H "Content-Type: application/json"
	-d '{
    "text": "EVENT_DESCRIPTION",
    "type": "EVENT_TYPE",
    "comments": "EVENT_COMMENTS",
    "resources": [
        {
            "id": "{{partner_resource_id}}",
            "name": "{{partner_resource_name}}",
            "mimeType": "{{partner_resource_mimeType}}"
        }
    ]
}'
https://domain.com/

Postman Collection Item JSON

{
  "name": "[Partner] Create a Transaction Event",
  "event": [
    {
      "listen": "test",
      "script": {
        "type": "text/javascript",
        "exec": [
          "// Extract Event identifier from response body",
          "var jsonData = JSON.parse(responseBody);",
          "var eventId = jsonData.id;",
          "",
          "// Set to an environment variable",
          "postman.setEnvironmentVariable(\"event_id\", eventId);"
        ]
      }
    }
  ],
  "_postman_id": "13de08d0-ce97-4bfa-9b95-518e06b6becc",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Authorization",
        "type": "text",
        "value": "Bearer {{partner_token}}"
      },
      {
        "key": "Content-Type",
        "name": "Content-Type",
        "type": "text",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"text\": \"EVENT_DESCRIPTION\",\n    \"type\": \"EVENT_TYPE\",\n    \"comments\": \"EVENT_COMMENTS\",\n    \"resources\": [\n        {\n            \"id\": \"{{partner_resource_id}}\",\n            \"name\": \"{{partner_resource_name}}\",\n            \"mimeType\": \"{{partner_resource_mimeType}}\"\n        }\n    ]\n}"
    },
    "url": "{{api_host}}/partner/v2/transactions/{{transaction_id}}/events"
  },
  "response": [
  ]
}