Chilkat Online Tools

Ruby / Salesforce Platform APIs / Publish single 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.

# {
#   "Annual_Mileage__c": 12000,
#   "Current_Vehicle__c": "Fast car",
#   "Model_Year__c": 2019
# }

json = Chilkat::CkJsonObject.new()
json.UpdateInt("Annual_Mileage__c",12000)
json.UpdateString("Current_Vehicle__c","Fast car")
json.UpdateInt("Model_Year__c",2019)

# Adds the "Authorization: Bearer <access_token>" header.
http.put_AuthToken("<access_token>")

# resp is a CkHttpResponse
resp = http.PostJson3("https://domain.com/services/data/v{{version}}/sobjects/:EventApiName/","application/json",json)
if (http.get_LastMethodSuccess() == false)
    print http.lastErrorText() + "\n";
    exit
end

sbResponseBody = Chilkat::CkStringBuilder.new()
resp.GetBodySb(sbResponseBody)

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print resp.header() + "\n";
    print "Failed." + "\n";

    exit
end

# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)

# {
#   "id": "e00xx0000000001AAA",
#   "success": true,
#   "errors": [
#     {
#       "statusCode": "OPERATION_ENQUEUED",
#       "message": "234995b6-53b6-4887-93fc-ecd0fac8b36c",
#       "fields": [
#       ]
#     }
#   ]
# }

# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

id = jResp.stringOf("id")
success = jResp.BoolOf("success")
i = 0
count_i = jResp.SizeOfArray("errors")
while i < count_i
    jResp.put_I(i)
    statusCode = jResp.stringOf("errors[i].statusCode")
    message = jResp.stringOf("errors[i].message")
    j = 0
    count_j = jResp.SizeOfArray("errors[i].fields")
    while j < count_j
        jResp.put_J(j)
        j = j + 1
    end
    i = i + 1
end

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-d '{
    "Annual_Mileage__c": 12000,
    "Current_Vehicle__c": "Fast car",
    "Model_Year__c": 2019
}'
https://domain.com/services/data/v{{version}}/sobjects/:EventApiName/

Postman Collection Item JSON

{
  "name": "Publish single event",
  "request": {
    "method": "POST",
    "header": [
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"Annual_Mileage__c\": 12000,\n    \"Current_Vehicle__c\": \"Fast car\",\n    \"Model_Year__c\": 2019\n}",
      "options": {
        "raw": {
          "language": "json"
        }
      }
    },
    "url": {
      "raw": "{{_endpoint}}/services/data/v{{version}}/sobjects/:EventApiName/",
      "host": [
        "{{_endpoint}}"
      ],
      "path": [
        "services",
        "data",
        "v{{version}}",
        "sobjects",
        ":EventApiName",
        ""
      ],
      "variable": [
        {
          "key": "EventApiName",
          "value": "Carbon_Comparison__e"
        }
      ]
    }
  },
  "response": [
    {
      "name": "Publish single event",
      "originalRequest": {
        "method": "POST",
        "header": [
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"Message__c\": \"Hello World!\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        },
        "url": {
          "raw": "{{_endpoint}}/services/data/v{{version}}/sobjects/:EventApiName/",
          "host": [
            "{{_endpoint}}"
          ],
          "path": [
            "services",
            "data",
            "v{{version}}",
            "sobjects",
            ":EventApiName",
            ""
          ],
          "variable": [
            {
              "key": "EventApiName",
              "value": "Sample__e"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Date",
          "value": "Mon, 03 Jul 2023 13:18:20 GMT"
        },
        {
          "key": "Strict-Transport-Security",
          "value": "max-age=63072000; includeSubDomains"
        },
        {
          "key": "X-Content-Type-Options",
          "value": "nosniff"
        },
        {
          "key": "X-Robots-Tag",
          "value": "none"
        },
        {
          "key": "Cache-Control",
          "value": "no-cache,must-revalidate,max-age=0,no-store,private"
        },
        {
          "key": "Sforce-Limit-Info",
          "value": "api-usage=16/15000"
        },
        {
          "key": "Location",
          "value": "/services/data/v58.0/sobjects/Sample__e/e00xx0000000001AAA"
        },
        {
          "key": "Content-Type",
          "value": "application/json;charset=UTF-8"
        },
        {
          "key": "Vary",
          "value": "Accept-Encoding"
        },
        {
          "key": "Content-Encoding",
          "value": "gzip"
        },
        {
          "key": "Transfer-Encoding",
          "value": "chunked"
        }
      ],
      "cookie": [
      ],
      "body": "{\n    \"id\": \"e00xx0000000001AAA\",\n    \"success\": true,\n    \"errors\": [\n        {\n            \"statusCode\": \"OPERATION_ENQUEUED\",\n            \"message\": \"234995b6-53b6-4887-93fc-ecd0fac8b36c\",\n            \"fields\": []\n        }\n    ]\n}"
    }
  ]
}