SQL Server / Support API / List Targets
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/targets', @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)
-- {
-- "targets": [
-- {
-- "project_id": "<string>",
-- "resource": "<string>",
-- "target_url": "<string>",
-- "title": "<string>",
-- "token": "<string>",
-- "type": "<string>",
-- "active": "<boolean>",
-- "created_at": "<dateTime>",
-- "id": "<integer>",
-- "message_id": "<string>",
-- "password": "<string>",
-- "todo_list_id": "<string>",
-- "username": "<string>"
-- },
-- {
-- "project_id": "<string>",
-- "resource": "<string>",
-- "target_url": "<string>",
-- "title": "<string>",
-- "token": "<string>",
-- "type": "<string>",
-- "active": "<boolean>",
-- "created_at": "<dateTime>",
-- "id": "<integer>",
-- "message_id": "<string>",
-- "password": "<string>",
-- "todo_list_id": "<string>",
-- "username": "<string>"
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @project_id nvarchar(4000)
DECLARE @resource nvarchar(4000)
DECLARE @target_url nvarchar(4000)
DECLARE @title nvarchar(4000)
DECLARE @token nvarchar(4000)
DECLARE @v_type nvarchar(4000)
DECLARE @active nvarchar(4000)
DECLARE @created_at nvarchar(4000)
DECLARE @id nvarchar(4000)
DECLARE @message_id nvarchar(4000)
DECLARE @password nvarchar(4000)
DECLARE @todo_list_id nvarchar(4000)
DECLARE @username nvarchar(4000)
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'targets'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @project_id OUT, 'targets[i].project_id'
EXEC sp_OAMethod @jResp, 'StringOf', @resource OUT, 'targets[i].resource'
EXEC sp_OAMethod @jResp, 'StringOf', @target_url OUT, 'targets[i].target_url'
EXEC sp_OAMethod @jResp, 'StringOf', @title OUT, 'targets[i].title'
EXEC sp_OAMethod @jResp, 'StringOf', @token OUT, 'targets[i].token'
EXEC sp_OAMethod @jResp, 'StringOf', @v_type OUT, 'targets[i].type'
EXEC sp_OAMethod @jResp, 'StringOf', @active OUT, 'targets[i].active'
EXEC sp_OAMethod @jResp, 'StringOf', @created_at OUT, 'targets[i].created_at'
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'targets[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @message_id OUT, 'targets[i].message_id'
EXEC sp_OAMethod @jResp, 'StringOf', @password OUT, 'targets[i].password'
EXEC sp_OAMethod @jResp, 'StringOf', @todo_list_id OUT, 'targets[i].todo_list_id'
EXEC sp_OAMethod @jResp, 'StringOf', @username OUT, 'targets[i].username'
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/targets
Postman Collection Item JSON
{
"name": "List Targets",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/targets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"targets"
]
},
"description": "#### Allowed For\n\n* Agents\n"
},
"response": [
{
"name": "Success response",
"originalRequest": {
"method": "GET",
"header": [
{
"description": "Added as a part of security scheme: basic",
"key": "Authorization",
"value": "Basic <credentials>"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/targets",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
"targets"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"targets\": [\n {\n \"project_id\": \"<string>\",\n \"resource\": \"<string>\",\n \"target_url\": \"<string>\",\n \"title\": \"<string>\",\n \"token\": \"<string>\",\n \"type\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"message_id\": \"<string>\",\n \"password\": \"<string>\",\n \"todo_list_id\": \"<string>\",\n \"username\": \"<string>\"\n },\n {\n \"project_id\": \"<string>\",\n \"resource\": \"<string>\",\n \"target_url\": \"<string>\",\n \"title\": \"<string>\",\n \"token\": \"<string>\",\n \"type\": \"<string>\",\n \"active\": \"<boolean>\",\n \"created_at\": \"<dateTime>\",\n \"id\": \"<integer>\",\n \"message_id\": \"<string>\",\n \"password\": \"<string>\",\n \"todo_list_id\": \"<string>\",\n \"username\": \"<string>\"\n }\n ]\n}"
}
]
}
