Chilkat Online Tools

SQL Server / Support API / Show Target

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/:target_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)

    -- {
    --   "target": {
    --     "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)
    EXEC sp_OAMethod @jResp, 'StringOf', @Project_id OUT, 'target.project_id'
    DECLARE @Resource nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Resource OUT, 'target.resource'
    DECLARE @Target_url nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Target_url OUT, 'target.target_url'
    DECLARE @Title nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Title OUT, 'target.title'
    DECLARE @Token nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Token OUT, 'target.token'
    DECLARE @v_Type nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @v_Type OUT, 'target.type'
    DECLARE @Active nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Active OUT, 'target.active'
    DECLARE @Created_at nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Created_at OUT, 'target.created_at'
    DECLARE @Id nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Id OUT, 'target.id'
    DECLARE @Message_id nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Message_id OUT, 'target.message_id'
    DECLARE @Password nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Password OUT, 'target.password'
    DECLARE @Todo_list_id nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Todo_list_id OUT, 'target.todo_list_id'
    DECLARE @Username nvarchar(4000)
    EXEC sp_OAMethod @jResp, 'StringOf', @Username OUT, 'target.username'

    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/:target_id

Postman Collection Item JSON

{
  "name": "Show Target",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/targets/:target_id",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "targets",
        ":target_id"
      ],
      "variable": [
        {
          "key": "target_id",
          "value": "<integer>"
        }
      ]
    },
    "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/:target_id",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "targets",
            ":target_id"
          ],
          "variable": [
            {
              "key": "target_id"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"target\": {\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}"
    }
  ]
}