Chilkat Online Tools

Powershell / Support API / List Targets

Back to Collection Items

Add-Type -Path "C:\chilkat\ChilkatDotNet47-x64\ChilkatDotNet47.dll"

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

$http = New-Object Chilkat.Http

$http.BasicAuth = $true
$http.Login = "login"
$http.Password = "password"

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

$sbResponseBody = New-Object Chilkat.StringBuilder
$success = $http.QuickGetSb("https://example.zendesk.com/api/v2/targets",$sbResponseBody)
if ($success -eq $false) {
    $($http.LastErrorText)
    exit
}

$jResp = New-Object Chilkat.JsonObject
$jResp.LoadSb($sbResponseBody)
$jResp.EmitCompact = $false

$("Response Body:")
$($jResp.Emit())

$respStatusCode = $http.LastStatus
$("Response Status Code = " + $respStatusCode)
if ($respStatusCode -ge 400) {
    $("Response Header:")
    $($http.LastHeader)
    $("Failed.")
    exit
}

# 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 -lt $count_i) {
    $jResp.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
}

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