SQL Server / Support API / Show Custom Object Field
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/fields/:custom_object_field_key_or_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_field": {
-- "key": "<string>",
-- "type": "<string>",
-- "title": "<string>",
-- "active": "<boolean>",
-- "created_at": "<dateTime>",
-- "custom_field_options": [
-- {
-- "name": "<string>",
-- "value": "<string>",
-- "id": "<integer>",
-- "position": "<integer>",
-- "raw_name": "<string>",
-- "url": "<string>"
-- },
-- {
-- "name": "<string>",
-- "value": "<string>",
-- "id": "<integer>",
-- "position": "<integer>",
-- "raw_name": "<string>",
-- "url": "<string>"
-- }
-- ],
-- "description": "<string>",
-- "id": "<integer>",
-- "position": "<integer>",
-- "raw_description": "<string>",
-- "raw_title": "<string>",
-- "regexp_for_validation": "<string>",
-- "relationship_filter": {},
-- "relationship_target_type": "<string>",
-- "system": "<boolean>",
-- "tag": "<string>",
-- "updated_at": "<dateTime>",
-- "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)
DECLARE @value nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @position nvarchar(4000)
DECLARE @raw_name nvarchar(4000)
DECLARE @url nvarchar(4000)
DECLARE @Key nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Key OUT, 'custom_object_field.key'
DECLARE @v_Type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'custom_object_field.type'
DECLARE @Title nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Title OUT, 'custom_object_field.title'
DECLARE @Active nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Active OUT, 'custom_object_field.active'
DECLARE @Created_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'custom_object_field.created_at'
DECLARE @Description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Description OUT, 'custom_object_field.description'
DECLARE @Id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'custom_object_field.id'
DECLARE @Position nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Position OUT, 'custom_object_field.position'
DECLARE @Raw_description nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Raw_description OUT, 'custom_object_field.raw_description'
DECLARE @Raw_title nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Raw_title OUT, 'custom_object_field.raw_title'
DECLARE @Regexp_for_validation nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Regexp_for_validation OUT, 'custom_object_field.regexp_for_validation'
DECLARE @Relationship_target_type nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Relationship_target_type OUT, 'custom_object_field.relationship_target_type'
DECLARE @System nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @System OUT, 'custom_object_field.system'
DECLARE @Tag nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Tag OUT, 'custom_object_field.tag'
DECLARE @Updated_at nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @Updated_at OUT, 'custom_object_field.updated_at'
DECLARE @v_Url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @v_Url OUT, 'custom_object_field.url'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'custom_object_field.custom_field_options'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'custom_object_field.custom_field_options[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'custom_object_field.custom_field_options[i].value'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'custom_object_field.custom_field_options[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @position OUT, 'custom_object_field.custom_field_options[i].position'
EXEC sp_OAMethod @jResp, 'StringOf', @raw_name OUT, 'custom_object_field.custom_field_options[i].raw_name'
EXEC sp_OAMethod @jResp, 'StringOf', @url OUT, 'custom_object_field.custom_field_options[i].url'
SELECT @i = @i + 1
END
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/fields/:custom_object_field_key_or_id
Postman Collection Item JSON
{
"name": "Show Custom Object Field",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/custom_objects/:custom_object_key/fields/:custom_object_field_key_or_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"fields",
":custom_object_field_key_or_id"
],
"variable": [
{
"key": "custom_object_key",
"value": "<string>"
},
{
"key": "custom_object_field_key_or_id",
"value": "<string>"
}
]
},
"description": "Returns a custom field for a specific object using a provided key or id of the field.\n#### Allowed For\n* Agents\n"
},
"response": [
{
"name": "Custom Object Field",
"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/fields/:custom_object_field_key_or_id",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"custom_objects",
":custom_object_key",
"fields",
":custom_object_field_key_or_id"
],
"variable": [
{
"key": "custom_object_key"
},
{
"key": "custom_object_field_key_or_id"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"custom_object_field\": {\n \"key\": \"<string>\",\n \"type\": \"<string>\",\n \"title\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"custom_field_options\": [\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n },\n {\n \"name\": \"<string>\",\n \"value\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_name\": \"<string>\",\n \"url\": \"<string>\"\n }\n ],\n \"description\": \"<string>\",\n \"id\": \"<integer>\",\n \"position\": \"<integer>\",\n \"raw_description\": \"<string>\",\n \"raw_title\": \"<string>\",\n \"regexp_for_validation\": \"<string>\",\n \"relationship_filter\": {},\n \"relationship_target_type\": \"<string>\",\n \"system\": \"<boolean>\",\n \"tag\": \"<string>\",\n \"updated_at\": \"<dateTime>\",\n \"url\": \"<string>\"\n }\n}"
}
]
}
