Powershell / Support API / Show Target
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/:target_id",$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)
# {
# "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
$Project_id = $jResp.StringOf("target.project_id")
$Resource = $jResp.StringOf("target.resource")
$Target_url = $jResp.StringOf("target.target_url")
$Title = $jResp.StringOf("target.title")
$Token = $jResp.StringOf("target.token")
$v_Type = $jResp.StringOf("target.type")
$Active = $jResp.StringOf("target.active")
$Created_at = $jResp.StringOf("target.created_at")
$Id = $jResp.StringOf("target.id")
$Message_id = $jResp.StringOf("target.message_id")
$Password = $jResp.StringOf("target.password")
$Todo_list_id = $jResp.StringOf("target.todo_list_id")
$Username = $jResp.StringOf("target.username")
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}"
}
]
}