Chilkat Online Tools

Ruby / Support API / List Targets

Back to Collection Items

require 'chilkat'

# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

http = Chilkat::CkHttp.new()

http.put_BasicAuth(true)
http.put_Login("login")
http.put_Password("password")

http.SetRequestHeader("Accept","application/json")

sbResponseBody = Chilkat::CkStringBuilder.new()
success = http.QuickGetSb("https://example.zendesk.com/api/v2/targets",sbResponseBody)
if (success == false)
    print http.lastErrorText() + "\n";
    exit
end

jResp = Chilkat::CkJsonObject.new()
jResp.LoadSb(sbResponseBody)
jResp.put_EmitCompact(false)

print "Response Body:" + "\n";
print jResp.emit() + "\n";

respStatusCode = http.get_LastStatus()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode >= 400)
    print "Response Header:" + "\n";
    print http.lastHeader() + "\n";
    print "Failed." + "\n";
    exit
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

i = 0
count_i = jResp.SizeOfArray("targets")
while i < count_i
    jResp.put_I(i)
    project_id = jResp.stringOf("targets[i].project_id")
    resource = jResp.stringOf("targets[i].resource")
    target_url = jResp.stringOf("targets[i].target_url")
    title = jResp.stringOf("targets[i].title")
    token = jResp.stringOf("targets[i].token")
    v_type = jResp.stringOf("targets[i].type")
    active = jResp.stringOf("targets[i].active")
    created_at = jResp.stringOf("targets[i].created_at")
    id = jResp.stringOf("targets[i].id")
    message_id = jResp.stringOf("targets[i].message_id")
    password = jResp.stringOf("targets[i].password")
    todo_list_id = jResp.stringOf("targets[i].todo_list_id")
    username = jResp.stringOf("targets[i].username")
    i = i + 1
end

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}"
    }
  ]
}