SQL Server / Support API / Show Custom Object Record
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'login'
EXEC sp_OASetProperty @http, 'Password', 'password'
EXEC sp_OAMethod @http, 'SetRequestHeader', NULL, 'Accept', 'application/json'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://example.zendesk.com/api/v2/custom_objects/:custom_object_key/records/:custom_object_record_id', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
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
DECLARE @Name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Name OUT, 'custom_object_record.name'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'custom_object_record.created_at'
DECLARE @Created_by_user_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_by_user_id OUT, 'custom_object_record.created_by_user_id'
DECLARE @Do8 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Do8 OUT, 'custom_object_record.custom_object_fields.do8'
DECLARE @Adipisicing_e nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Adipisicing_e OUT, 'custom_object_record.custom_object_fields.adipisicing_e'
DECLARE @Commodo0 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Commodo0 OUT, 'custom_object_record.custom_object_fields.commodo0'
DECLARE @Sunta4 nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Sunta4 OUT, 'custom_object_record.custom_object_fields.sunta4'
DECLARE @Custom_object_key nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Custom_object_key OUT, 'custom_object_record.custom_object_key'
DECLARE @External_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @External_id OUT, 'custom_object_record.external_id'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'custom_object_record.id'
DECLARE @Updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'custom_object_record.updated_at'
DECLARE @Updated_by_user_id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_by_user_id OUT, 'custom_object_record.updated_by_user_id'
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'custom_object_record.url'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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}"
}
]
}
