autoit / Support API / Get sources by target
Back to Collection Items
; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess
$oHttp.BasicAuth = True
$oHttp.Login = "login"
$oHttp.Password = "password"
$oHttp.SetRequestHeader "Accept","application/json"
$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://example.zendesk.com/api/v2/:target_type/:target_id/relationship_fields/:field_id/:source_type",$oSbResponseBody)
If ($bSuccess = False) Then
ConsoleWrite($oHttp.LastErrorText & @CRLF)
Exit
EndIf
$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False
ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)
Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
ConsoleWrite("Response Header:" & @CRLF)
ConsoleWrite($oHttp.LastHeader & @CRLF)
ConsoleWrite("Failed." & @CRLF)
Exit
EndIf
; Sample JSON response:
; (Sample code for parsing the JSON response is shown below)
; {
; "users": [
; {
; "name": "<string>",
; "active": "<boolean>",
; "alias": "<string>",
; "chat_only": "<boolean>",
; "created_at": "<string>",
; "custom_role_id": "<integer>",
; "default_group_id": "<integer>",
; "details": "<string>",
; "email": "<string>",
; "external_id": "<string>",
; "iana_time_zone": "<string>",
; "id": "<integer>",
; "last_login_at": "<string>",
; "locale": "<string>",
; "locale_id": "<integer>",
; "moderator": "<boolean>",
; "notes": "<string>",
; "only_private_comments": "<boolean>",
; "organization_id": "<integer>",
; "phone": "<string>",
; "photo": {
; "in1f": false,
; "cillumb5": true
; },
; "remote_photo_url": "<string>",
; "report_csv": "<boolean>",
; "restricted_agent": "<boolean>",
; "role": "<string>",
; "role_type": "<integer>",
; "shared": "<boolean>",
; "shared_agent": "<boolean>",
; "shared_phone_number": "<boolean>",
; "signature": "<string>",
; "suspended": "<boolean>",
; "tags": "<array>",
; "ticket_restriction": "<string>",
; "time_zone": "<string>",
; "two_factor_auth_enabled": "<boolean>",
; "updated_at": "<string>",
; "url": "<string>",
; "user_fields": {
; "nisi_e": "commodo exercitation consequat"
; },
; "verified": "<boolean>"
; },
; {
; "name": "<string>",
; "active": "<boolean>",
; "alias": "<string>",
; "chat_only": "<boolean>",
; "created_at": "<string>",
; "custom_role_id": "<integer>",
; "default_group_id": "<integer>",
; "details": "<string>",
; "email": "<string>",
; "external_id": "<string>",
; "iana_time_zone": "<string>",
; "id": "<integer>",
; "last_login_at": "<string>",
; "locale": "<string>",
; "locale_id": "<integer>",
; "moderator": "<boolean>",
; "notes": "<string>",
; "only_private_comments": "<boolean>",
; "organization_id": "<integer>",
; "phone": "<string>",
; "photo": {
; "ut69": true,
; "magna_4": -92520384
; },
; "remote_photo_url": "<string>",
; "report_csv": "<boolean>",
; "restricted_agent": "<boolean>",
; "role": "<string>",
; "role_type": "<integer>",
; "shared": "<boolean>",
; "shared_agent": "<boolean>",
; "shared_phone_number": "<boolean>",
; "signature": "<string>",
; "suspended": "<boolean>",
; "tags": "<array>",
; "ticket_restriction": "<string>",
; "time_zone": "<string>",
; "two_factor_auth_enabled": "<boolean>",
; "updated_at": "<string>",
; "url": "<string>",
; "user_fields": {
; "Loremcc": 52379422,
; "dolore7": true,
; "pariaturf": "magna consectet"
; },
; "verified": "<boolean>"
; }
; ]
; }
; Sample code for parsing the JSON response...
; Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
Local $sName
Local $sActive
Local $sAlias
Local $sChat_only
Local $sCreated_at
Local $sCustom_role_id
Local $sDefault_group_id
Local $sDetails
Local $sEmail
Local $sExternal_id
Local $sIana_time_zone
Local $sId
Local $sLast_login_at
Local $sLocale
Local $sLocale_id
Local $sModerator
Local $sNotes
Local $sOnly_private_comments
Local $sOrganization_id
Local $sPhone
Local $bIn1f
Local $bCillumb5
Local $sRemote_photo_url
Local $sReport_csv
Local $sRestricted_agent
Local $sRole
Local $sRole_type
Local $sV_shared
Local $shared_agent
Local $shared_phone_number
Local $signature
Local $suspended
Local $sTags
Local $sTicket_restriction
Local $sTime_zone
Local $sTwo_factor_auth_enabled
Local $sUpdated_at
Local $sUrl
Local $sNisi_e
Local $sVerified
Local $bUt69
Local $iMagna_4
Local $iLoremcc
Local $bDolore7
Local $sPariaturf
Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("users")
While $i < $iCount_i
$oJResp.I = $i
$sName = $oJResp.StringOf("users[i].name")
$sActive = $oJResp.StringOf("users[i].active")
$sAlias = $oJResp.StringOf("users[i].alias")
$sChat_only = $oJResp.StringOf("users[i].chat_only")
$sCreated_at = $oJResp.StringOf("users[i].created_at")
$sCustom_role_id = $oJResp.StringOf("users[i].custom_role_id")
$sDefault_group_id = $oJResp.StringOf("users[i].default_group_id")
$sDetails = $oJResp.StringOf("users[i].details")
$sEmail = $oJResp.StringOf("users[i].email")
$sExternal_id = $oJResp.StringOf("users[i].external_id")
$sIana_time_zone = $oJResp.StringOf("users[i].iana_time_zone")
$sId = $oJResp.StringOf("users[i].id")
$sLast_login_at = $oJResp.StringOf("users[i].last_login_at")
$sLocale = $oJResp.StringOf("users[i].locale")
$sLocale_id = $oJResp.StringOf("users[i].locale_id")
$sModerator = $oJResp.StringOf("users[i].moderator")
$sNotes = $oJResp.StringOf("users[i].notes")
$sOnly_private_comments = $oJResp.StringOf("users[i].only_private_comments")
$sOrganization_id = $oJResp.StringOf("users[i].organization_id")
$sPhone = $oJResp.StringOf("users[i].phone")
$bIn1f = $oJResp.BoolOf("users[i].photo.in1f")
$bCillumb5 = $oJResp.BoolOf("users[i].photo.cillumb5")
$sRemote_photo_url = $oJResp.StringOf("users[i].remote_photo_url")
$sReport_csv = $oJResp.StringOf("users[i].report_csv")
$sRestricted_agent = $oJResp.StringOf("users[i].restricted_agent")
$sRole = $oJResp.StringOf("users[i].role")
$sRole_type = $oJResp.StringOf("users[i].role_type")
$sV_shared = $oJResp.StringOf("users[i].shared")
$shared_agent = $oJResp.StringOf("users[i].shared_agent")
$shared_phone_number = $oJResp.StringOf("users[i].shared_phone_number")
$signature = $oJResp.StringOf("users[i].signature")
$suspended = $oJResp.StringOf("users[i].suspended")
$sTags = $oJResp.StringOf("users[i].tags")
$sTicket_restriction = $oJResp.StringOf("users[i].ticket_restriction")
$sTime_zone = $oJResp.StringOf("users[i].time_zone")
$sTwo_factor_auth_enabled = $oJResp.StringOf("users[i].two_factor_auth_enabled")
$sUpdated_at = $oJResp.StringOf("users[i].updated_at")
$sUrl = $oJResp.StringOf("users[i].url")
$sNisi_e = $oJResp.StringOf("users[i].user_fields.nisi_e")
$sVerified = $oJResp.StringOf("users[i].verified")
$bUt69 = $oJResp.BoolOf("users[i].photo.ut69")
$iMagna_4 = $oJResp.IntOf("users[i].photo.magna_4")
$iLoremcc = $oJResp.IntOf("users[i].user_fields.Loremcc")
$bDolore7 = $oJResp.BoolOf("users[i].user_fields.dolore7")
$sPariaturf = $oJResp.StringOf("users[i].user_fields.pariaturf")
$i = $i + 1
Wend
Curl Command
curl -u login:password -X GET
-H "Accept: application/json"
https://example.zendesk.com/api/v2/:target_type/:target_id/relationship_fields/:field_id/:source_type
Postman Collection Item JSON
{
"name": "Get sources by target",
"request": {
"method": "GET",
"header": [
{
"key": "Accept",
"value": "application/json"
}
],
"url": {
"raw": "{{baseUrl}}/api/v2/:target_type/:target_id/relationship_fields/:field_id/:source_type",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
":target_type",
":target_id",
"relationship_fields",
":field_id",
":source_type"
],
"variable": [
{
"key": "target_type",
"value": "<string>"
},
{
"key": "target_id",
"value": "<integer>"
},
{
"key": "field_id",
"value": "<integer>"
},
{
"key": "source_type",
"value": "<string>"
}
]
},
"description": "Returns a list of source objects whose values are populated with the id of a related target object. For example,\nif you have a lookup field called \"Success Manager\" on a ticket, this endpoint can answer the question,\n\"What tickets (sources) is this user (found by `target_type` and `target_id`)\nassigned as the 'Success Manager' (field referenced by `field_id`)?\"\n\n#### 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/:target_type/:target_id/relationship_fields/:field_id/:source_type",
"host": [
"{{baseUrl}}"
],
"path": [
"api",
"v2",
":target_type",
":target_id",
"relationship_fields",
":field_id",
":source_type"
],
"variable": [
{
"key": "target_type"
},
{
"key": "target_id"
},
{
"key": "field_id"
},
{
"key": "source_type"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"users\": [\n {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"in1f\": false,\n \"cillumb5\": true\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"nisi_e\": \"commodo exercitation consequat\"\n },\n \"verified\": \"<boolean>\"\n },\n {\n \"name\": \"<string>\",\n \"active\": \"<boolean>\",\n \"alias\": \"<string>\",\n \"chat_only\": \"<boolean>\",\n \"created_at\": \"<string>\",\n \"custom_role_id\": \"<integer>\",\n \"default_group_id\": \"<integer>\",\n \"details\": \"<string>\",\n \"email\": \"<string>\",\n \"external_id\": \"<string>\",\n \"iana_time_zone\": \"<string>\",\n \"id\": \"<integer>\",\n \"last_login_at\": \"<string>\",\n \"locale\": \"<string>\",\n \"locale_id\": \"<integer>\",\n \"moderator\": \"<boolean>\",\n \"notes\": \"<string>\",\n \"only_private_comments\": \"<boolean>\",\n \"organization_id\": \"<integer>\",\n \"phone\": \"<string>\",\n \"photo\": {\n \"ut69\": true,\n \"magna_4\": -92520384\n },\n \"remote_photo_url\": \"<string>\",\n \"report_csv\": \"<boolean>\",\n \"restricted_agent\": \"<boolean>\",\n \"role\": \"<string>\",\n \"role_type\": \"<integer>\",\n \"shared\": \"<boolean>\",\n \"shared_agent\": \"<boolean>\",\n \"shared_phone_number\": \"<boolean>\",\n \"signature\": \"<string>\",\n \"suspended\": \"<boolean>\",\n \"tags\": \"<array>\",\n \"ticket_restriction\": \"<string>\",\n \"time_zone\": \"<string>\",\n \"two_factor_auth_enabled\": \"<boolean>\",\n \"updated_at\": \"<string>\",\n \"url\": \"<string>\",\n \"user_fields\": {\n \"Loremcc\": 52379422,\n \"dolore7\": true,\n \"pariaturf\": \"magna consectet\"\n },\n \"verified\": \"<boolean>\"\n }\n ]\n}"
}
]
}
