Chilkat Online Tools

Ruby / Support API / Show Custom Object Record

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()

http.put_BasicAuth(true)
http.put_Login("login")
http.put_Password("password")

http.SetRequestHeader("Accept","application/json")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

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

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

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
end

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

# {
#   "custom_object_record": {
#     "name": "<string>",
#     "created_at": "<dateTime>",
#     "created_by_user_id": "<string>",
#     "custom_object_fields": {
#       "do8": "<string>",
#       "adipisicing_e": "<string>",
#       "commodo0": "<string>",
#       "sunta4": "<string>"
#     },
#     "custom_object_key": "<string>",
#     "external_id": "<string>",
#     "id": "<string>",
#     "updated_at": "<dateTime>",
#     "updated_by_user_id": "<string>",
#     "url": "<string>"
#   }
# }

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

Name = jResp.stringOf("custom_object_record.name")
Created_at = jResp.stringOf("custom_object_record.created_at")
Created_by_user_id = jResp.stringOf("custom_object_record.created_by_user_id")
Do8 = jResp.stringOf("custom_object_record.custom_object_fields.do8")
Adipisicing_e = jResp.stringOf("custom_object_record.custom_object_fields.adipisicing_e")
Commodo0 = jResp.stringOf("custom_object_record.custom_object_fields.commodo0")
Sunta4 = jResp.stringOf("custom_object_record.custom_object_fields.sunta4")
Custom_object_key = jResp.stringOf("custom_object_record.custom_object_key")
External_id = jResp.stringOf("custom_object_record.external_id")
Id = jResp.stringOf("custom_object_record.id")
Updated_at = jResp.stringOf("custom_object_record.updated_at")
Updated_by_user_id = jResp.stringOf("custom_object_record.updated_by_user_id")
v_Url = jResp.stringOf("custom_object_record.url")

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id

Postman Collection Item JSON

{
  "name": "Show Custom Object Record",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "custom_objects",
        ":custom_object_key",
        "records",
        ":custom_object_record_id"
      ],
      "variable": [
        {
          "key": "custom_object_key",
          "value": "<string>"
        },
        {
          "key": "custom_object_record_id",
          "value": "<string>"
        }
      ]
    },
    "description": "Returns a custom record for a specific object using a provided id.\n#### Allowed For\n* Agents\n"
  },
  "response": [
    {
      "name": "Custom Object Record",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "custom_objects",
            ":custom_object_key",
            "records",
            ":custom_object_record_id"
          ],
          "variable": [
            {
              "key": "custom_object_key"
            },
            {
              "key": "custom_object_record_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"custom_object_record\": {\n    \"name\": \"<string>\",\n    \"created_at\": \"<dateTime>\",\n    \"created_by_user_id\": \"<string>\",\n    \"custom_object_fields\": {\n      \"do8\": \"<string>\",\n      \"adipisicing_e\": \"<string>\",\n      \"commodo0\": \"<string>\",\n      \"sunta4\": \"<string>\"\n    },\n    \"custom_object_key\": \"<string>\",\n    \"external_id\": \"<string>\",\n    \"id\": \"<string>\",\n    \"updated_at\": \"<dateTime>\",\n    \"updated_by_user_id\": \"<string>\",\n    \"url\": \"<string>\"\n  }\n}"
    }
  ]
}