TCL / Support API / Show Custom Object Record
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]
CkHttp_put_BasicAuth $http 1
CkHttp_put_Login $http "login"
CkHttp_put_Password $http "password"
CkHttp_SetRequestHeader $http "Accept" "application/json"
set sbResponseBody [new_CkStringBuilder]
set success [CkHttp_QuickGetSb $http "https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id" $sbResponseBody]
if {$success == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
exit
}
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttp_get_LastStatus $http]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttp_lastHeader $http]
puts "Failed."
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
# 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
set Name [CkJsonObject_stringOf $jResp "custom_object_record.name"]
set Created_at [CkJsonObject_stringOf $jResp "custom_object_record.created_at"]
set Created_by_user_id [CkJsonObject_stringOf $jResp "custom_object_record.created_by_user_id"]
set Do8 [CkJsonObject_stringOf $jResp "custom_object_record.custom_object_fields.do8"]
set Adipisicing_e [CkJsonObject_stringOf $jResp "custom_object_record.custom_object_fields.adipisicing_e"]
set Commodo0 [CkJsonObject_stringOf $jResp "custom_object_record.custom_object_fields.commodo0"]
set Sunta4 [CkJsonObject_stringOf $jResp "custom_object_record.custom_object_fields.sunta4"]
set Custom_object_key [CkJsonObject_stringOf $jResp "custom_object_record.custom_object_key"]
set External_id [CkJsonObject_stringOf $jResp "custom_object_record.external_id"]
set Id [CkJsonObject_stringOf $jResp "custom_object_record.id"]
set Updated_at [CkJsonObject_stringOf $jResp "custom_object_record.updated_at"]
set Updated_by_user_id [CkJsonObject_stringOf $jResp "custom_object_record.updated_by_user_id"]
set v_Url [CkJsonObject_stringOf $jResp "custom_object_record.url"]
delete_CkHttp $http
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
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}"
}
]
}